{"id":16726125,"url":"https://github.com/mrbartusek/readmeactivityfeed","last_synced_at":"2025-03-15T15:24:19.864Z","repository":{"id":48526109,"uuid":"409637281","full_name":"MrBartusek/ReadmeActivityFeed","owner":"MrBartusek","description":"Simple NPM package for generating list of recent Github activity of a user to put in your profile README ⚡","archived":false,"fork":false,"pushed_at":"2021-10-01T10:53:56.000Z","size":63,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-15T01:31:47.876Z","etag":null,"topics":["github-activity","github-api","npm","profile-readme","readme","readme-profile","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MrBartusek.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-23T15:01:48.000Z","updated_at":"2022-08-06T10:29:32.000Z","dependencies_parsed_at":"2022-09-04T11:41:29.871Z","dependency_job_id":null,"html_url":"https://github.com/MrBartusek/ReadmeActivityFeed","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MrBartusek%2FReadmeActivityFeed","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MrBartusek%2FReadmeActivityFeed/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MrBartusek%2FReadmeActivityFeed/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MrBartusek%2FReadmeActivityFeed/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MrBartusek","download_url":"https://codeload.github.com/MrBartusek/ReadmeActivityFeed/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243747568,"owners_count":20341514,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-activity","github-api","npm","profile-readme","readme","readme-profile","typescript"],"created_at":"2024-10-12T22:52:14.490Z","updated_at":"2025-03-15T15:24:19.842Z","avatar_url":"https://github.com/MrBartusek.png","language":"TypeScript","readme":"# Readme Activity Feed\n \n[![npm](https://img.shields.io/npm/v/readme-activity-feed)](https://www.npmjs.com/package/readme-activity-feed) [![build status](https://img.shields.io/github/workflow/status/MrBartusek/ReadmeActivityFeed/build)](https://github.com/MrBartusek/TechnologyShields/actions)\n\nSimple NPM package for generating list of recent Github activity of a user to put in your profile `README.md`.\nThis works similarly to [github-activity-readme](https://github.com/jamesgeorge007/github-activity-readme) or\n[activity-box](https://github.com/JasonEtco/activity-box) but it's a actually library rather than an action.\n\n## Installation\n\n```bash\nnpm install readme-activity-feed\n```\n\n## Usage\n\nThis library exports `generate` function with alias `Generate`. It takes 3 arguments:\n\n| Parameter  | Type                   | Optional | Default                             | Description |\n| ---------- | ---------------------- | :------: | ----------------------------------- | ----------- |\n| username   | `string`               |          |                                     | Github username of a user. |\n| maxEvents  | `number`               | ✓        | 5                                   | The maximum number of lines generated. |\n| token      | `str`                  | ✓        | `GITHUB_TOKEN` environment variable | The [PAT](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) used for authentication to the Github API. By default it uses `GITHUB_TOKEN` which is present when running in Github Actions. |\n\n### Usage\n\n\u003e You can see how it work on my [profile readme](https://github.com/MrBartusek)\n\n```js\nconst readmeActivityFeed = require(\"readme-activity-feed\")\n\nconsole.log(readmeActivityFeed.generate(\"MrBartusek\"))\n```\n\nExample Output:\n\n💪 Opened PR [#8](https://github.com/MrBartusek/ReadmeActivityFeed/pull/19370) in [MrBartusek/ReadmeActivityFeed](https://github.com/MrBartusek/ReadmeActivityFeed)\u003cbr\u003e\n🏷️ Published [v1.0.0](https://github.com/MrBartusek/ReadmeActivityFeed/releases/tag/v1.0.0) of [MrBartusek/ReadmeActivityFeed](https://github.com/ReadmeActivityFeed)\u003cbr\u003e\n❗️ Closed [#42](https://github.com/MrBartusek/ReadmeActivityFeed/issues/42) in [MrBartusek/ReadmeActivityFeed](https://github.com/MrBartusek/ReadmeActivityFeed)\u003cbr\u003e\n🗣 Commented on [#42](https://github.com/MrBartusek/ReadmeActivityFeed/issues/42) in [MrBartusek/ReadmeActivityFeed](https://github.com/MrBartusek/ReadmeActivityFeed)\u003cbr\u003e\n🔀 Forked [MrBartusek/ReadmeActivityFeed](https://github.com/MrBartusek/ReadmeActivityFeed)\u003cbr\u003e\n🎉 Published [MrBartusek/ReadmeActivityFeed](https://github.com/MrBartusek/ReadmeActivityFeed)\u003cbr\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrbartusek%2Freadmeactivityfeed","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrbartusek%2Freadmeactivityfeed","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrbartusek%2Freadmeactivityfeed/lists"}