eliastreis / contributor-table

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

contributor-table

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

Usage

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 for details.

Contributors

Name	GitHub	Twitter
Hugh Kennedy	hughsk	@hughskennedy