https://github.com/hughsk/contributor-table

Automatically inject a list of your git repository's contributors into your readme.
https://github.com/hughsk/contributor-table

Last synced: 3 months ago
JSON representation

Automatically inject a list of your git repository's contributors into your readme.

• Host: GitHub
• URL: https://github.com/hughsk/contributor-table
• Owner: hughsk
• License: other
• Created: 2015-06-24T05:53:23.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-06-24T05:54:05.000Z (almost 10 years ago)
• Last Synced: 2025-03-07T13:06:02.418Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 85 KB
• Stars: 16
• Watchers: 2
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# contributor-table

![](http://img.shields.io/badge/stability-stable-orange.svg?style=flat)

![](http://img.shields.io/npm/v/contributor-table.svg?style=flat)

![](http://img.shields.io/npm/dm/contributor-table.svg?style=flat)

![](http://img.shields.io/npm/l/contributor-table.svg?style=flat)

Automatically inject a list of your git repository's contributors into your

readme.

## Usage

[![NPM](https://nodei.co/npm/contributor-table.png)](https://nodei.co/npm/contributor-table/)

    Usage: contributor-table {OPTIONS}

    Automatically inject a list of your git repository's

    contributors into your readme.

    Options:

      -d, --dirname  The git project to check for contributors. Default: $(pwd)

      -r, --readme   The readme file to process and update. Default: README.md

      -c, --check    Ignore the email cache and prompt for new user details again.

                     Useful for correcting mistakes.

On encountering a new email address, you'll be prompted

for that user's github/twitter accounts. This could be done

semi-automatically but turns out it's just simpler this way.

You'll only need to do this once per email on your system :)

## License

MIT. See [LICENSE.md](http://github.com/hughsk/contributor-table/blob/master/LICENSE.md) for details.

## Contributors

| Name             | GitHub                              | Twitter                                           |

| ---------------- | ----------------------------------- | ------------------------------------------------- |

| **Hugh Kennedy** | [hughsk](https://github.com/hughsk) | [@hughskennedy](https://twitter.com/hughskennedy) |