1.0.4 • Published 9 years ago
github-issues-to-readme v1.0.4
Installation
Download node at nodejs.org and install it, if you haven't already.
Install the package globally.
npm install github-issues-to-readme --global
Create an OAuth token on GitHub
- 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
. - In the config file, fill in values:
{ "token": "<your GitHub auth token here>" }
- Add a
repository
field in yourpackage.json
- Add a header
# Issues
at the end of your README.md file - Run
github-issues-to-readme
from the root of the project