diff options
author | Claudius Coenen | 2019-04-01 01:31:05 +0200 |
---|---|---|
committer | GitHub | 2019-04-01 01:31:05 +0200 |
commit | a95f1e9f560d1d869db8d4289725ac9abb0e8939 (patch) | |
tree | d049536b0662c5677d19fc4ef228c5b98ba76849 /docs/guides/auth/twitter.md | |
parent | 3a0ff5edd3882cca3751bcfbca1843807ef0c7d7 (diff) | |
parent | ba6ede57bd32aae79bbcf41964777374620aeab0 (diff) |
Merge pull request #15 from ccoenen/feature/documentation-overhaul
Documentation overhaul
Diffstat (limited to '')
-rw-r--r-- | docs/guides/auth/twitter.md | 42 |
1 files changed, 19 insertions, 23 deletions
diff --git a/docs/guides/auth/twitter.md b/docs/guides/auth/twitter.md index 1b96288f..1973515c 100644 --- a/docs/guides/auth/twitter.md +++ b/docs/guides/auth/twitter.md @@ -1,33 +1,29 @@ Authentication guide - Twitter === -***Note:** This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* +**Note:** *This guide was written before the renaming. Just replace `HackMD` with `CodiMD` in your mind :smile: thanks!* 1. Sign-in or sign-up for a Twitter account 2. Go to the Twitter Application management page [here](https://apps.twitter.com/) -3. Click on the **Create New App** button to create a new Twitter app: +3. Click on the **Create New App** button to create a new Twitter app: + ![create-twitter-app](../../images/auth/create-twitter-app.png) -![create-twitter-app](../images/auth/create-twitter-app.png) +4. Fill out the create application form, check the developer agreement box, and click **Create Your Twitter Application** + ![register-twitter-application](../../images/auth/register-twitter-application.png) -4. Fill out the create application form, check the developer agreement box, and click **Create Your Twitter Application** + *Note: you may have to register your phone number with Twitter to create a Twitter application* -![register-twitter-application](../images/auth/register-twitter-application.png) + To do this Click your profile icon --> Settings and privacy --> Mobile --> Select Country/region --> Enter phone number --> Click Continue -*Note: you may have to register your phone number with Twitter to create a Twitter application* +5. After you receive confirmation that the Twitter application was created, click **Keys and Access Tokens** + ![twitter-app-confirmation](../../images/auth/twitter-app-confirmation.png) -To do this Click your profile icon --> Settings and privacy --> Mobile --> Select Country/region --> Enter phone number --> Click Continue +6. Obtain your Twitter Consumer Key and Consumer Secret + ![twitter-app-keys](../../images/auth/twitter-app-keys.png) -5. After you receive confirmation that the Twitter application was created, click **Keys and Access Tokens** - -![twitter-app-confirmation](../images/auth/twitter-app-confirmation.png) - -6. Obtain your Twitter Consumer Key and Consumer Secret - -![twitter-app-keys](../images/auth/twitter-app-keys.png) - -7. Add your Consumer Key and Consumer Secret to your config.json file or pass them as environment variables: - * config.json: - ````javascript +7. Add your Consumer Key and Consumer Secret to your `config.json` file or pass them as environment variables: + * `config.json`: + ```javascript { "production": { "twitter": { @@ -36,9 +32,9 @@ To do this Click your profile icon --> Settings and privacy --> Mobile --> Sele } } } - ```` + ``` * environment variables: - ```` - HMD_TWITTER_CONSUMERKEY=esTCJFXXXXXXXXXXXXXXXXXXX - HMD_TWITTER_CONSUMERSECRET=zpCs4tU86pRVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX - ```` + ```sh + CMD_TWITTER_CONSUMERKEY=esTCJFXXXXXXXXXXXXXXXXXXX + CMD_TWITTER_CONSUMERSECRET=zpCs4tU86pRVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + ``` |