diff --git a/.gitignore b/.gitignore index 61f2900..51409dc 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ *~ *.log node_modules +*.env diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index d4de3ab..c70bdc9 100644 --- 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 index 03301e0..6b485e6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + [![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