Skip to content

Commit caf586c

Browse files
authored
Merge pull request #172 from streamdevs/167-improve-readme
docs: Improve readme
2 parents 8fce59c + f462be6 commit caf586c

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,38 @@
99
![license](https://img.shields.io/github/license/streamdevs/webhook.svg)
1010
![Node.js CI](https://github.com/streamdevs/webhook/workflows/Node.js%20CI/badge.svg)
1111

12-
A webhook to forward GitHub events to StreamLabs Alerts and Twitch Chat.
12+
## Goal
1313

14-
![Apr-21-2020 9-18-24 PM](https://user-images.githubusercontent.com/7255298/79904917-bc816e00-8415-11ea-98ca-7525b169ef49.gif)
14+
A webhook to forward GitHub and GitLab events to StreamLabs Alerts and Twitch Chat.
1515

16-
## Deploy to Heroku
16+
This is a tool created with live-coding streamers in mind. The goal is to have another source of
17+
interaction and showcase relevant activity on GitHub to their audience on streaming platforms
18+
generating more interest in their Open Source projects.
19+
20+
![StreamDevs Webhook Demo](https://user-images.githubusercontent.com/7255298/79904917-bc816e00-8415-11ea-98ca-7525b169ef49.gif)
21+
22+
## Features
23+
24+
### GitHub
25+
26+
We support the following events:
27+
28+
- Stars
29+
- Forks
30+
- Releases
31+
- Issues
32+
- Opened
33+
- Assigned
34+
- Pull Requests
35+
- Opened
36+
- Merged
1737

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

2040
## Manual deploy
2141

42+
### Deploy to Heroku
43+
2244
```
2345
git clone https://github.com/streamdevs/webhook.git
2446
cd webhook
@@ -97,3 +119,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
97119
<!-- prettier-ignore-end -->
98120

99121
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
122+
123+
## License
124+
125+
This project is under the [CC-BY 4.0](https://github.com/streamdevs/webhook/blob/master/license.md) license

0 commit comments

Comments
 (0)