gh-conf / rhof

Fetch contributors list and generate hall of fame for github readme

rhof

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

Install

$ npm i @gh-conf/rhof

Usage

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);
    // <a href='https://github.com/arshadkazmi42'><img src="https://github.com/arshadkazmi42.png" width="30" /></a>
  } catch (error) {
    console.log(error);
  }
})();

Contributing

Interested in contributing to this project? You can log any issues or suggestion related to this library here

Read our contributing guide on getting started with contributing to the codebase

rhof's Issues

Change install statement in README

Change install statement in README to
npm i @gh-conf/rhof

License Badge

Add LICENSE badge in README

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

Contributors badge

Add contributors badge in README

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

Link to contributors profile broken

README has broken link to contributors profile under contributors section.

Current URL:
https://github.com/arshadkazmi42)

Expected URL:
https://github.com/arshadkazmi42

change travis to github workflow

Remove contributors section from README

We don't need the contribution section in readme as now Github shows the contributors list in right sidebar.

Remove the Contributors section from README.md

Add badges to readme

1. Install npm badger npm install npm-badger -g
2. Clone this repository git clone https://github.com/gh-conf/rhof
3. Go to root directory cd rhof
4. Run npm badger npm-badger
5. Commit README.md file
6. Create Pull Request

release v1.0.4

Github Repo Size Badge

Add Github Repo Size Badge in README

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

NPM Version Badge

Add NPM version badge in README

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

fix vulnerability

• Delete package-lock.json
• Run npm install
• Commit all the changes
• Create a Pull request

Remove yarn.lock file

Build passing badge in readme

Add below line in README.md right below the title

[![Build](https://img.shields.io/travis/com/gh-conf/rhof.svg)](https://travis-ci.com/gh-conf/rhof)

Fix formatter

HOF formatter is not replacing username in the image link

<a href="https://github.com/arshadkazmi42"><img src="https://github.com/{username}.png" width="30" /></a>

Logic for this formatter is in this function https://github.com/gh-conf/rhof/blob/master/lib/format-hof.js#L10-L17

Fix vulnerability

Update package-lock.json

add downloads badge

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

add the above code in README.md with other badges

Remove constants.js file

This file constants.js is not getting used anymore and we can get this removed.

move constants to gh-constants

Change import statement in readme

Change import statement from
const rhof = require('rhof');
to
const rhof = require('@gh-conf/rhof');

in README.md usage

Release to NPM