README.md

humans

Automatically update a GitHub repository with a list of contributors.

This is especially useful for maintaining a humans.txt file on a GitHub Pages site.

Note: private repositories are not currently supported, but will be soon.

Prerequisites

The following software must be installed on your system:

• jq
• Git
• cURL

You also need to associate your server's SSH key with your GitHub account so commits can automatically be pushed.

Installation

git clone https://github.com/alyssais/humans
cd humans
./configure
make install

You can also specify how often to check for contributors when running make install (defaults to hourly):

make install SCHEDULE="0 * * * *"

SCHEDULE can be set to any valid CRON expression.

Contributing

1. Fork this repository
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a pull request