https://github.com/gh-conf/rhof

Fetch contributors list and generate hall of fame for github readme
https://github.com/gh-conf/rhof

contributors gh-conf github hacktoberfest hof

Last synced: 29 days ago
JSON representation

Fetch contributors list and generate hall of fame for github readme

• Host: GitHub
• URL: https://github.com/gh-conf/rhof
• Owner: gh-conf
• License: mit
• Created: 2019-02-03T10:47:22.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-10-16T15:44:10.000Z (over 2 years ago)
• Last Synced: 2025-04-27T11:05:16.583Z (about 1 month ago)
• Topics: contributors, gh-conf, github, hacktoberfest, hof
• Language: JavaScript
• Homepage:
• Size: 253 KB
• Stars: 2
• Watchers: 1
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# rhof

[![Build](https://github.com/gh-conf/rhof/actions/workflows/nodejs.yml/badge.svg)](https://github.com/gh-conf/rhof/actions/workflows/nodejs.yml)

[![NPM Version](https://img.shields.io/npm/v/rhof.svg)](https://www.npmjs.com/package/rhof)

[![NPM Downloads](https://img.shields.io/npm/dt/rhof.svg)](https://www.npmjs.com/package/rhof)

[![Github Repo Size](https://img.shields.io/github/repo-size/gh-conf/rhof.svg)](https://github.com/gh-conf/rhof)

[![LICENSE](https://img.shields.io/npm/l/rhof.svg)](https://github.com/gh-conf/rhof/blob/master/LICENSE)

[![Contributors](https://img.shields.io/github/contributors/gh-conf/rhof.svg)](https://github.com/gh-conf/rhof/graphs/contributors)

[![Commit](https://img.shields.io/github/last-commit/gh-conf/rhof.svg)](https://github.com/gh-conf/rhof/commits/master)

Fetch contributors list of github repository and generate hall of fame for github readme

## Install

```

$ npm i @gh-conf/rhof

```

## Usage

```javascript

const rhof = require('@gh-conf/rhof');

(async () => {

  try {

    const username = 'arshadkazmi42'; //github username

    const repository = 'gh-rhof'; // github repository name

    const hof = await rhof(username, repository);

    console.log(hof);

    // 

  } catch (error) {

    console.log(error);

  }

})();

```

## Contributing

Interested in contributing to this project?

You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/rhof/issues/new)

Read our contributing [guide](CONTRIBUTING.md) on getting started with contributing to the codebase