https://github.com/mrbartusek/readmeactivityfeed

Simple NPM package for generating list of recent Github activity of a user to put in your profile README ⚡
https://github.com/mrbartusek/readmeactivityfeed

github-activity github-api npm profile-readme readme readme-profile typescript

Last synced: about 1 month ago
JSON representation

Simple NPM package for generating list of recent Github activity of a user to put in your profile README ⚡

• Host: GitHub
• URL: https://github.com/mrbartusek/readmeactivityfeed
• Owner: MrBartusek
• License: mit
• Created: 2021-09-23T15:01:48.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-01T10:53:56.000Z (about 3 years ago)
• Last Synced: 2024-10-15T01:31:47.876Z (2 months ago)
• Topics: github-activity, github-api, npm, profile-readme, readme, readme-profile, typescript
• Language: TypeScript
• Homepage:
• Size: 61.5 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Readme Activity Feed

 

[![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)

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](https://github.com/jamesgeorge007/github-activity-readme) or

[activity-box](https://github.com/JasonEtco/activity-box) but it's a actually library rather than an action.

## Installation

```bash

npm install readme-activity-feed

```

## Usage

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](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. |

### Usage

> You can see how it work on my [profile readme](https://github.com/MrBartusek)

```js

const readmeActivityFeed = require("readme-activity-feed")

console.log(readmeActivityFeed.generate("MrBartusek"))

```

Example Output:

💪 Opened PR [#8](https://github.com/MrBartusek/ReadmeActivityFeed/pull/19370) in [MrBartusek/ReadmeActivityFeed](https://github.com/MrBartusek/ReadmeActivityFeed)


🏷️ Published [v1.0.0](https://github.com/MrBartusek/ReadmeActivityFeed/releases/tag/v1.0.0) of [MrBartusek/ReadmeActivityFeed](https://github.com/ReadmeActivityFeed)


❗️ Closed [#42](https://github.com/MrBartusek/ReadmeActivityFeed/issues/42) in [MrBartusek/ReadmeActivityFeed](https://github.com/MrBartusek/ReadmeActivityFeed)


🗣 Commented on [#42](https://github.com/MrBartusek/ReadmeActivityFeed/issues/42) in [MrBartusek/ReadmeActivityFeed](https://github.com/MrBartusek/ReadmeActivityFeed)


🔀 Forked [MrBartusek/ReadmeActivityFeed](https://github.com/MrBartusek/ReadmeActivityFeed)


🎉 Published [MrBartusek/ReadmeActivityFeed](https://github.com/MrBartusek/ReadmeActivityFeed)