Updated docs

IonicaBizau · Jul 13, 2017 · 4e808b2 · 4e808b2
1 parent f99569c
commit 4e808b2
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 *~
 *.log
 node_modules
+*.env
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -6,6 +6,7 @@ You can see below the API reference of this module.
 Fetches the GitHub contributions calendar data (in JSON format).
 
 #### Params
+
 - **String|Object** `username`: The username or an object containing:
  - `username` (String): The GitHub username.
  - `cookie` (String): An optional cookie. Could be useful to get the private calendar stats.

diff --git a/README.md b/README.md
@@ -1,3 +1,4 @@
+<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
 
 [![ghcal](http://i.imgur.com/yzElGZN.png)](#)
 
@@ -103,13 +104,15 @@ GhCal("ionicabizau", function (err, data) {
 });
 ```
 
+
+
 ## :question: Get Help
 
 There are few ways to get help:
 
  1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
  2. For bug reports and feature requests, open issues. :bug:
- 3. For direct and quick help from me, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
+ 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
 
 
 ## :memo: Documentation