From 8b72ef31f440fd02486603bf90f3fb56da8881ce Mon Sep 17 00:00:00 2001 From: jehf denezaire Date: Thu, 19 Sep 2019 22:33:26 -0400 Subject: [PATCH] updated CI --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8803274..d57a23b 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,31 @@ # 📡Hooks -[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) + +[![Shellhacks](https://hackathon.badge.pw/shellhacks)](https://shellhacks.net)[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) A little NodeJS server for managing GitHub events +--- + +## Getting started + +1. Set up your environment + + - [Set up](https://developer.github.com/webhooks/creating/#setting-up-a-webhook) Github [Webhooks](https://help.github.com/en/articles/about-webhooks) for your repo(s) + - Create a [`.env`](https://github.com/UPE-FIU/Hooks/blob/master/example.env) file and add your secrets + +2. Add repo path(s) and command(s) in [repositories.js](https://github.com/UPE-FIU/Hooks/blob/jehf-bug-fix/repositories.js) + +3. [Fire it up](https://github.com/UPE-FIU/Hooks/tree/master#available-commands) 🚀 + + - Feel free to PR changes or create an issue with any suggestions 😃 + ## Available Commands +... `yarn start` - Starts PM2 process with argument `--name`
`yarn stop` - Stops process
`yarn restart` - Restarts process
-`yarn status` - Logs process status
-`yarn clear` - Clear process' logs
-`yarn delete` - Deletes process
+... For more details see [package.json](https://github.com/UPE-FIU/Hooks/blob/master/package.json) @@ -29,6 +44,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! \ No newline at end of file +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!