Skip to content

Commit c97e6e5

Browse files
committed
docs: Whitespace
1 parent 39725fc commit c97e6e5

File tree

1 file changed

+49
-47
lines changed

1 file changed

+49
-47
lines changed

README.md

Lines changed: 49 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -17,52 +17,56 @@ A webhook to forward GitHub events to StreamLabs Alerts and Twitch Chat.
1717

1818
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
1919

20-
2120
## Setup
2221

2322
There are a few requirements for the integration to work.
24-
25-
- [ ] Your webhook is on a server, running 24/7
23+
24+
- [ ] Your webhook is on a server, running 24/7
2625
- [ ] Your webhook is able to receive HTTP requests from GitHub/GitLab.
2726
- [ ] Your repository (and/or user/organisation) on GitHub/GitLab is configured to notify your
28-
webhook
29-
27+
webhook
28+
3029
You can deploy this webhook in different ways
3130

3231
### Deploy to Heroku
3332

3433
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
3534

3635
## Configuration
36+
3737
### Deploy to your own server
3838

3939
0. Get the source code
40-
```
41-
git clone https://github.com/streamdevs/webhook.git
42-
```
43-
0. Change into the source code directory
44-
```
45-
cd webhook
46-
```
47-
0. Install the dependencies with yarn (or alternative you can use `npm`)
48-
```
49-
yarn install
50-
```
51-
```
52-
0. Create a .env file with your (configuration)[#configuration] and the edit it
53-
```
54-
cp .env.example .env
55-
```
56-
0. Compile the project to JavaScript
57-
```
58-
yarn build
59-
```
60-
0. Run the start command
61-
```
62-
yarn run start
63-
```
64-
0. You should see your webhook running on the port specified in the configuration below
40+
```
41+
git clone https://github.com/streamdevs/webhook.git
42+
```
43+
1. Change into the source code directory
44+
```
45+
cd webhook
46+
```
47+
2. Install the dependencies with yarn (or alternative you can use `npm`)
48+
49+
```
50+
yarn install
51+
```
6552

53+
```
54+
55+
```
56+
57+
3. Create a .env file with your (configuration)[#configuration] and the edit it
58+
```
59+
cp .env.example .env
60+
```
61+
4. Compile the project to JavaScript
62+
```
63+
yarn build
64+
```
65+
5. Run the start command
66+
```
67+
yarn run start
68+
```
69+
6. You should see your webhook running on the port specified in the configuration below
6670

6771
We make use of the following environment variables:
6872

@@ -86,23 +90,21 @@ We make use of the following environment variables:
8690
#### Repositories
8791

8892
0. Open your repository settings on GitHub.
89-
0. Go to the **Webhooks** section.
90-
0. Click on **Add webhook**.
91-
0. On the **Payload** field, enter the GitHub endpoint for your deployed webhook. For example `https://YOUR-SITE-HERE.herokuapp.com/github`.
92-
0. For **Content type** we want to select `application/json`.
93-
0. On **Which events would you like to trigger this webhook?** select `Let me select individual
94-
events`.
95-
0. On the list of events check the following:
96-
- Check runs
97-
- Forks
98-
- Issues
99-
- Pull requests
100-
- Releases
101-
- Stars
102-
0. Make sure the `Active` checkbox is checked
103-
0. Click on `Add webhook`
104-
0. You will receive your first notification on Twitch Chat and StreamLabs letting you now your webhook has been configured correctly.
105-
93+
1. Go to the **Webhooks** section.
94+
2. Click on **Add webhook**.
95+
3. On the **Payload** field, enter the GitHub endpoint for your deployed webhook. For example `https://YOUR-SITE-HERE.herokuapp.com/github`.
96+
4. For **Content type** we want to select `application/json`.
97+
5. On **Which events would you like to trigger this webhook?** select `Let me select individual events`.
98+
6. On the list of events check the following:
99+
- Check runs
100+
- Forks
101+
- Issues
102+
- Pull requests
103+
- Releases
104+
- Stars
105+
7. Make sure the `Active` checkbox is checked
106+
8. Click on `Add webhook`
107+
9. You will receive your first notification on Twitch Chat and StreamLabs letting you now your webhook has been configured correctly.
106108

107109
[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)
108110

0 commit comments

Comments
 (0)