docs: Add deployment and GitHub configuration guide

Resolves #125

Author: orestes

README.md

@@ -17,16 +17,52 @@ A webhook to forward GitHub events to StreamLabs Alerts and Twitch Chat.
 
 [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
 
-## Manual deploy
+    
+## Setup
 
-```
-git clone https://github.com/streamdevs/webhook.git
-cd webhook
-yarn
-yarn start
-```
+There are a few requirements for the integration to work.
+ 
+- [ ] Your webhook is on a server, running 24/7 
+- [ ] Your webhook is able to receive HTTP requests from GitHub/GitLab.
+- [ ] Your repository (and/or user/organisation) on GitHub/GitLab is configured to notify your
+ webhook
+ 
+You can deploy this webhook in different ways
+
+### Deploy to Heroku
+
+[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
 
 ## Configuration
+### Deploy to your own server
+
+0. Get the source code
+    ```
+    git clone https://github.com/streamdevs/webhook.git
+    ```
+0. Change into the source code directory
+    ```
+    cd webhook
+    ```
+0. Install the dependencies with yarn (or alternative you can use `npm`)
+    ```
+    yarn install
+    ```
+    ```
+0. Create a .env file with your (configuration)[#configuration] and the edit it
+    ```
+   cp .env.example .env
+    ```
+0. Compile the project to JavaScript
+    ```
+    yarn build
+    ```
+0. Run the start command
+    ```
+    yarn run start
+    ```
+0. You should see your webhook running on the port specified in the configuration below
+
 
 We make use of the following environment variables:
 
@@ -45,6 +81,29 @@ We make use of the following environment variables:
 
 ### For sponsorships
 
+### GitHub Configuration
+
+#### Repositories
+
+0. Open your repository settings on GitHub.
+0. Go to the **Webhooks** section.
+0. Click on **Add webhook**.
+0. On the **Payload** field, enter the GitHub endpoint for your deployed webhook. For example `https://YOUR-SITE-HERE.herokuapp.com/github`.
+0. For **Content type** we want to select `application/json`.
+0. On **Which events would you like to trigger this webhook?** select `Let me select individual
+ events`.
+0. On the list of events check the following:
+    - Check runs
+    - Forks
+    - Issues
+    - Pull requests
+    - Releases
+    - Stars
+0. Make sure the `Active` checkbox is checked
+0. Click on `Add webhook`
+0. You will receive your first notification on Twitch Chat and StreamLabs letting you now your webhook has been configured correctly.
+
+
 [Check the GitHub documentation](https://help.github.com/en/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)
 
 ## Contributing