From 4ae626ad39b5996532504d6cecacb3a24af4d1f4 Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Fri, 15 Mar 2019 14:39:39 -0400 Subject: [PATCH] Update setup docs --- README.md | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 96e85df..a0ff67d 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,26 @@ ## Setup -Create a GitHub Gist and create a token with the `gist` scope. +### Prep work -Register a Twitter app and create a `.env` file: +1. Create a new public GitHub Gist (https://gist.github.com/) +1. Create a token with the `gist` scope and copy it. (https://github.com/settings/tokens/new) +1. Create a new Twitter app (https://developer.twitter.com/en/apps/create) +1. On the App page for your newly created app, generate an "Access token & access token secret" and copy all keys and tokens. -``` -GIST_ID= -GITHUB_TOKEN= +### Project setup -TWITTER_USER= -TWITTER_CONSUMER_KEY= -TWITTER_CONSUMER_SECRET= -TWITTER_ACCESS_TOKEN_KEY= -TWITTER_ACCESS_TOKEN_SECRET= -``` +1. Fork this repo +1. Log into CircleCI with your GitHub (https://circleci.com/vcs-authorize/) +1. Click on "Add Projects" on the sidebar +1. Set up a project with the newly created fork +1. Go to Project Settings > Environment Variables +1. Add the following environment variables: -Adjust poll rate in `.circleci/config.yml`. +- **GIST_ID:** The ID portion from your gist url https://gist.github.com/matchai/6d5f84419863089a167387da62dd7081. +- **GITHUB_TOKEN:** The GitHub token generated above. +- **TWITTER_USER:** The user handle of the twitter account. +- **TWITTER_CONSUMER_KEY:** Your Twitter consumer API key. +- **TWITTER_CONSUMER_SECRET:** Your Twitter consumer secret. +- **TWITTER_ACCESS_TOKEN_KEY:** Your Twitter access token key. +- **TWITTER_ACCESS_TOKEN_SECRET:** Your Twitter access token secret.