Installation

Download node at nodejs.org and install it, if you haven't already.

1. Install the package globally.

   npm install github-issues-to-readme --global

2. Create an OAuth token on GitHub

3. Create a config file named ~/.config/github-issue-flattener. You'll probably want to change permissions, e.g. sudo chmod 0600 ~/.config/github-issue-flattener.

4. In the config file, fill in values:

   {
     "token": "<your GitHub auth token here>"
   }

5. Add a repository field in your package.json

6. Add a header # Issues at the end of your README.md file

7. Run github-issues-to-readme from the root of the project