From b1dc276608d881b0128c97d53afea61416a1a555 Mon Sep 17 00:00:00 2001 From: Orestes Carracedo Date: Sat, 2 May 2020 23:34:37 +0200 Subject: [PATCH 1/5] docs: Clarify goal --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2e51411..6e2f091 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,16 @@ ![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) [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) From b3ded0cc7c66ff936e5f3c82dcc5f0fbb30f424e Mon Sep 17 00:00:00 2001 From: Orestes Carracedo Date: Sat, 2 May 2020 23:35:01 +0200 Subject: [PATCH 2/5] docs: List current features --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 6e2f091..67f0746 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,22 @@ interaction and showcase relevant activity on GitHub to their audience on stream 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) From b6e179d58cfc0440c6c46223ba0bcfb744d2408e Mon Sep 17 00:00:00 2001 From: Orestes Carracedo Date: Sat, 2 May 2020 23:36:20 +0200 Subject: [PATCH 3/5] docs: Fix hierarchy --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 67f0746..ea1a4d9 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,6 @@ 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. @@ -39,6 +38,7 @@ We support the following events: [![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 From 29d5348adc390debc6f84704eec5e50b197d03b6 Mon Sep 17 00:00:00 2001 From: Orestes Carracedo Date: Sat, 2 May 2020 23:36:35 +0200 Subject: [PATCH 4/5] docs: Add license information Resolves #167 --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index ea1a4d9..ac3c233 100644 --- a/README.md +++ b/README.md @@ -118,3 +118,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d 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 From f462be6063174a9c9451d7cb7ceeba8ff60fc013 Mon Sep 17 00:00:00 2001 From: Orestes Carracedo Date: Sat, 2 May 2020 23:40:04 +0200 Subject: [PATCH 5/5] chore: Whitespace --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ac3c233..6f96b31 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ interaction and showcase relevant activity on GitHub to their audience on stream 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 @@ -28,16 +29,16 @@ We support the following events: - Forks - Releases - Issues - - Opened - - Assigned + - Opened + - Assigned - Pull Requests - - Opened - - Merged - + - Opened + - Merged [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) ## Manual deploy + ### Deploy to Heroku ```