Skip to content

Give contribution credit where contribution credit is due

License

Notifications You must be signed in to change notification settings

the-after-hours/contri-credit

Repository files navigation

Contri-credit

Contribution credit where contribution credit is due. Automatically build and update your CONTRIBUTORS file.

Installation

npm install --global contri-credit

Add the configuration object to your package.json

"contri-credit": {
    "file": "CONTRIBUTORS.md"    // Or your own markdown file to write to
    "owner": "the-after-hours"   // Probably your user name
    "repo": "contri-credit"      // Your repository name
}

Usage

Contri-credit can be used as global cli to generate a contributors file for any github project.

If you installed contri-credit globally, from your project root, run credit to generate the CONTRIBUTORS.md file

Contributors

Project maintained by The After Hours For a full list of contributors, please see CONTRIBUTORS.md

About

Give contribution credit where contribution credit is due

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published