Updated docs

.gitignore

@@ -3,3 +3,7 @@
 *~
 *.log
 node_modules
+*.env
+.DS_Store
+package-lock.json
+.bloggify/*

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013-2020 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
+Copyright (c) 2013-20 Ionică Bizău <bizauionica@gmail.com> (https://ionicabizau.net)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

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. -->
 
 
 
@@ -6,31 +7,117 @@
 
 
 
+[![gh-contributions](http://i.imgur.com/w6nVEgj.png)](#)
+
+
+
+
+
+
+
+
+
+
+
+# `$ gh-contributions`
+
+ [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/gh-contributions.svg)](https://www.npmjs.com/package/gh-contributions) [![Downloads](https://img.shields.io/npm/dt/gh-contributions.svg)](https://www.npmjs.com/package/gh-contributions) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
+
+<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
+
+
+
+
+
+
+
+> A tool that generates a repository which being pushed into your GitHub account creates a nice contributions calendar.
+
+
+
+
+
+
 
 
 
 
 
 
-![gh-contributions](http://i.imgur.com/w6nVEgj.png)
 
 
 
 
-# gh-contributions
 
-A tool that generates a repository which being pushed into your GitHub account creates a nice contributions calendar.
 
 
 
 
 ## Installation
 
+### Global installation
+
+
+[Ensure you configured NPM and NodeJS not to require `sudo` when installing packages globally](https://github.com/IonicaBizau/dotfiles#npm-config).
+
+```js
+$ npm i -g gh-contributions
+```
+
+
+To start the GitHub contributions server, do:
+
+```js
+$ gh-contributions
+```
+
+### Notes for installing on Windows
+
+
+For this application to work well on Windows, Git must be installed with the option to put it in `PATH` enabled, like in this screenshot:
+
+![](http://i.imgur.com/UOkx35j.png "")
+
+
+If Git is not installed with this option selected, *gh-contributions* will not be able to generate the repository.
+
+### Local installation
+
+```js
+$ git clone git@github.com:IonicaBizau/github-contributions.git
+$ cd github-contributions
+$ npm i
+$ npm start
+```
+
+## Usage
+
+
+The server runs on the `9000` port. Open `http://localhost:9000/` in your browser.
+
+Check the help information on the app page (`http://localhost:9000`), after you start the app.
+
+### Running Server Inside Docker Container
+
+
+**You will need to use a version lower than `3.0.0` to run this in Docker. Currently this is not supported anymore.**
+
+
+Build Docker container locally:
+
+```sh
+docker build -t github-contributions .
+```
+
+
+Start Docker container:
+
 ```sh
-$ npm i gh-contributions
+docker run --rm -it -p 127.0.0.1:9000:9000 --name=github-contributions-server github-contributions
 ```
 
 
+Open `http://localhost:9000/` in your browser.
 
 
 
@@ -39,7 +126,6 @@ $ npm i gh-contributions
 
 
 
-## Documentation
 
 
 
@@ -49,16 +135,100 @@ $ npm i gh-contributions
 
 
 
+## :question: Get Help
 
-## How to contribute
+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, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## :yum: How to contribute
 Have an idea? Found a bug? See [how to contribute][contributing].
 
 
+## :sparkling_heart: Support my projects
+I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
+this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
+
+However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
+
+
+ - Starring and sharing the projects you like :rocket:
+ - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
+ - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
+ - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
+ - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
+
+    ![](https://i.imgur.com/z6OQI95.png)
+
+
+Thanks! :heart:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## :dizzy: Where is this library used?
+If you are using this library in one of your projects, add it in this list. :sparkles:
+
+ - `auto-contribution`
+
+
+
+
+
+
+
+
+
+
+
+## :scroll: License
+
+[MIT][license] © [Ionică Bizău][website]
+
+
+
 
-## License
-See the [LICENSE][license] file.
 
 
 [license]: /LICENSE
+[website]: https://ionicabizau.net
 [contributing]: /CONTRIBUTING.md
 [docs]: /DOCUMENTATION.md
+[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
+[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
+[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
+[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
+[patreon]: https://www.patreon.com/ionicabizau
+[amazon]: http://amzn.eu/hRo9sIZ
+[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW

package.json

@@ -148,4 +148,4 @@
     "bloggify.json",
     "bloggify/"
   ]
-}
+}