1.1.1 ā¢ Published 3 years ago
readme-activity-feed v1.1.1
Readme Activity Feed
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.
Installation
npm install readme-activity-feedUsage
This 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. This don't need to be provided but then, you can hit the ratelimit. |
Usage
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