diff --git a/README.md b/README.md index e35d3203..201f4206 100644 --- a/README.md +++ b/README.md @@ -32,9 +32,15 @@ Here are some behaviors that we plan to implement: ## Installing -TODO: install the hosted integration into your organization / account +0. **[Install the demo integration](https://github.com/integration/probot-demo)** - note that this is very likely to go away at some point soon. It will suffice for experimenting for now, but it is for demo purposes only. +0. Create a `.probot.yml` file in your repository. See [Configuring](#configuring). -TODO: deploy your own bot +### Deploy your own bot to Heroku + +0. [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) - Click this button and pick an **App Name** that Heroku is happy with, like `your-name-probot`. Before you can complete this, you'll need config variables from the next step. +0. In another tab, [create an integration](https://developer.github.com/early-access/integrations/creating-an-integration/) on GitHub, using `your-app-name.herokuapp.com` as the **Homepage URL**, **Callback URL**, and **Webhook URL**. The permissions and events that your bot needs access to will depend on what you use it for. +0. After creating your GitHub integration, go back to the Heroku tab and fill in the configuration variables with the values for the GitHub Integration +0. Create a `.probot.yml` file in your repository. See [Configuring](#configuring). ## Configuring