Skip to content

docs: Improve readme #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 3, 2020
Merged

docs: Improve readme #172

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b1dc276
docs: Clarify goal
orestes May 2, 2020
b3ded0c
docs: List current features
orestes May 2, 2020
b6e179d
docs: Fix hierarchy
orestes May 2, 2020
29d5348
docs: Add license information
orestes May 2, 2020
f462be6
chore: Whitespace
orestes May 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,38 @@
![license](https://img.shields.io/github/license/streamdevs/webhook.svg)
![Node.js CI](https://github.com/streamdevs/webhook/workflows/Node.js%20CI/badge.svg)

A webhook to forward GitHub events to StreamLabs Alerts and Twitch Chat.
## Goal

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

## Deploy to Heroku
This is a tool created with live-coding streamers in mind. The goal is to have another source of
interaction and showcase relevant activity on GitHub to their audience on streaming platforms
generating more interest in their Open Source projects.

![StreamDevs Webhook Demo](https://user-images.githubusercontent.com/7255298/79904917-bc816e00-8415-11ea-98ca-7525b169ef49.gif)

## Features

### GitHub

We support the following events:

- Stars
- Forks
- Releases
- Issues
- Opened
- Assigned
- Pull Requests
- Opened
- Merged

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

## Manual deploy

### Deploy to Heroku

```
git clone https://github.com/streamdevs/webhook.git
cd webhook
Expand Down Expand Up @@ -97,3 +119,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<!-- prettier-ignore-end -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

## License

This project is under the [CC-BY 4.0](https://github.com/streamdevs/webhook/blob/master/license.md) license