Simple NPM package for generating list of recent Github activity of a user to put in your profile README.md.
This works similarly to github-activity-readme or
activity-box but it's a actually library rather than an action.
npm install readme-activity-feedThis library exports generate function with alias Generate. It takes 3 arguments:
| Parameter | Type | Optional | Default | Description |
|---|---|---|---|---|
| username | string |
Github username of a user. | ||
| maxEvents | number |
✓ | 5 | The maximum number of lines generated. |
| token | str |
✓ | GITHUB_TOKEN environment variable |
The PAT used for authentication to the Github API. By default it uses GITHUB_TOKEN which is present when running in Github Actions. |
You can see how it work on my profile readme
const readmeActivityFeed = require("readme-activity-feed")
console.log(readmeActivityFeed.generate("MrBartusek"))Example Output:
💪 Opened PR #8 in MrBartusek/ReadmeActivityFeed
🏷️ Published v1.0.0 of MrBartusek/ReadmeActivityFeed
❗️ Closed #42 in MrBartusek/ReadmeActivityFeed
🗣 Commented on #42 in MrBartusek/ReadmeActivityFeed
🔀 Forked MrBartusek/ReadmeActivityFeed
🎉 Published MrBartusek/ReadmeActivityFeed