Merge pull request #4 from UPE-FIU/jehf-bug-fix

Jehf bug fix

.all-contributorsrc

@@ -0,0 +1,26 @@
+{
+  "projectName": "Hooks",
+  "projectOwner": "jehfkemsy",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 50,
+  "commit": true,
+  "commitConvention": "eslint",
+  "contributors": [
+    {
+      "login": "Jehfkemsy",
+      "name": "Jehf Denezaire",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/32716551?v=4",
+      "profile": "https://github.com/jehfkemsy",
+      "contributions": [
+        "code",
+        "bug",
+        "doc"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7
+}

README.md

@@ -1,20 +1,52 @@
 # 📡Hooks
 
+[![Shellhacks](https://hackathon.badge.pw/shellhacks)](https://shellhacks.net) [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
+
 A little NodeJS server for managing GitHub events
 
+---
+
+## Getting started
+
+1. Setting up your environment
+
+   - [Set up](https://developer.github.com/webhooks/creating/#setting-up-a-webhook) your Github [Webhooks](https://help.github.com/en/articles/about-webhooks)
+   - Create a [`.env`](https://github.com/UPE-FIU/Hooks/blob/master/example.env) file and add your [secret(s)](https://developer.github.com/webhooks/creating/#secret)
+
+2. Add your repo path(s) and command(s) in [repositories.js](https://github.com/UPE-FIU/Hooks/blob/jehf-bug-fix/repositories.js)
+
+3. [Fire it up](https://github.com/UPE-FIU/Hooks/tree/master#available-commands) 🚀
+
+   - Feel free to PR changes or create an issue with any suggestions 😃
+
 ## Available Commands
 
+...
+<br/>
 `yarn start` - Starts PM2 process with argument `--name`</br>
 `yarn stop` - Stops process </br>
 `yarn restart` - Restarts process </br>
-`yarn status` - Logs process status </br>
-`yarn clear` - Clear process' logs </br>
-`yarn delete` - Deletes process </br>
+...
+
+> For more details see [package.json](https://github.com/UPE-FIU/Hooks/blob/master/package.json)
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://upe.cs.fiu.edu"><img src="https://avatars0.githubusercontent.com/u/32716551?v=4" width="50px;" alt="Jehf Denezaire"/><br /><sub><b>Jehf Denezaire</b></sub></a><br /><a href="https://github.com/jehfkemsy/Hooks/commits?author=Jehfkemsy" title="Code">💻</a> <a href="https://github.com/jehfkemsy/Hooks/issues?q=author%3AJehfkemsy" title="Bug reports">🐛</a> <a href="https://github.com/jehfkemsy/Hooks/commits?author=Jehfkemsy" title="Documentation">📖</a></td>
+  </tr>
+</table>
 
-For more details see [package.json](https://github.com/UPE-FIU/Hooks/blob/master/package.json)
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
 
-## Authors
+<!-- ALL-CONTRIBUTORS-LIST:END -->
 
-[@Jehfkemsy](https://github.com/jehfkemsy)
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
 
-## Contributors 

package.json

@@ -18,5 +18,8 @@
     "dependencies": {
         "dotenv": "^8.0.0",
         "pm2": "^3.5.1"
+    },
+    "devDependencies": {
+        "all-contributors-cli": "^6.9.1"
     }
 }