diff --git a/README.md b/README.md new file mode 100644 index 0000000..e70df4b --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# antell-lunchmenu-flowdock +Antell lunchmenu integration for Flowdock. + +## Setting up the integration +Setting up this integration requires: + +1. A server for the integration to run on at scheduled intervals +2. A Flowdock source token +3. A scheduler which runs the script every morning + +### tl;dr if you know what you're doing +* `git clone && cd antell-lunchmenu-flowdock && npm i` +* Create flowdock app, get (source) token for your flow +* Set up env vars, see section in this readme +* run `npm run lunchmenu` every morning + +### Hosting on Heroku for free +The easiest way to host the integration is to [create a free Heroku dyno](https://signup.heroku.com/) with all dynos scaled to zero. +[Heroku's free tier](https://www.heroku.com/free) offers 1000 hours of dyno uptime per month. +This integration only runs during scheduled intervals for a few seconds, meaning that the free tier is more than enough. + +### Steps + +1. Fork this repository to your Github account +2. Create a new developer application in Flowdock - https://www.flowdock.com/oauth/applications + 1. Create the app, tick **Shortcut application** + 2. Go to your newly created app and **Create a new source** for the flow which you want menus to be sent. It will give you a 32-character *token* - store this and keep it safe. This token lets the script post messages to your flwo. +2. Sign up for a Heroku account and create a new personal app - https://signup.heroku.com/ + 1. In the **Deploy tab**, choose Github as the **Deployment method**, then choose the repository you just forked + 2. Go to the **Settings** tab + + ... todo + +## Environmental variables +