diff --git a/README.md b/README.md index b885133..0db07fb 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,38 @@ If your system does not have _wget_, you can also use _curl_: curl https://raw.github.com/IonicaBizau/gh-contributions/master/installer.sh | sh +Usage +----- + +The installer script will create a folder in `home` called `gh-contributions`. So enter in that folder (`cd ~/gh-contributions`) and run `node server` or directly: + +``` +node ~/gh-contributions/server.js +``` + +The application runs on the port `9000`. Open your browser at `http://localhost:9000/` there you will see the contribution designer. You will draw the commits. A JSON object is generated: + +```JSON +{ + "coordinates": [ + { + "x": ..., + "y": ... + }, + ... + { + ... + } + ], + "commitsPerDay": 40 +} +``` + +Edit the `commitsPerDay` value. That sets the day commit count. +Then click the generate button and wait... :-) You can delight with the debug messages from terminal while the repository is generated. + +After the repository is finished you will get a link for download. Unzip the zip file, add your remote git repository and run `git push -u origin master`. + Example -------