summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorluca-marie <ml.kochsiek@fu-berlin.de>2016-09-13 15:36:02 +0200
committerluca-marie <ml.kochsiek@fu-berlin.de>2016-09-13 15:36:02 +0200
commitf4235e5b8b56844108052a29a5f63fc7602c2960 (patch)
tree1246d1ab736aa2df10689d580a1ab9d31f884b25 /README.md
parent10fae60eb36156858bb892013fa13678bdf11a48 (diff)
parent599a4b163a7f41073725e8c5435124c9e8f15203 (diff)
Merge branch 'marie' into develop
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 2 insertions, 31 deletions
diff --git a/README.md b/README.md
index 4c2921a..923b239 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,7 @@ The LEAP Web App provides the following functions:
* Webfinger access to user’s public keys
* Email aliases and forwarding
* Localized and Customizable documentation
+* Display of status updates from Twitter (access to tweets via Twitter API)
Written in: Ruby, Rails.
@@ -36,6 +37,7 @@ For more information, see these files in the ``doc`` directory:
* DEPLOY -- for notes on deployment.
* DEVELOP -- for developer notes.
* CUSTOM -- how to customize.
+* TWITTER_FEED -- how to use it.
External docs:
@@ -186,34 +188,3 @@ Known problems
attacks. These are very hard to prevent, because our protocol is
designed to allow query of a user database via proxy in order to
provide network perspective.
-
-Twitter Timeline on Main View
----------------------------
-
-This is a feature to include a twitter feed that displays most recent tweets
-of a (determined) twitter account (accessed via Twitter API).
-If you chose to use it, the feature gets included in `home/index` of
-LEAP web app (as part of the main view).
-
-* Create Twitter Application on https://apps.twitter.com/
- * Visit https://apps.twitter.com/ and log in with the twitter account you want to use
- * Make sure you have a mobile phone number registered with your account to be able to proceed
- * Choose the option to `Create New App`
- * Fill in Application Details and Developer Agreement and `Create your Twitter application`
- * Choose the section "Keys and Access Tokens" to get your consumer key and consumer secret
- * Optional: Go to section "Permissions" and change the "Access" from `Read and Write` (by default) to `Read only`
- * Have your consumer key and secret by hand for one of the next steps
-
-* Activate the feature within your local LEAP Web Application
- * If not already existing create a secrets-file in /config with the name secrets.yml (`/config/secrets.yml`)
- * Secrets-file should contain the following, make sure its in YAML: {"development"=> {"twitter"=>{"enabled"=>false, "twitter_handle"=>"", "bearer_token"=>"", "twitter_picture"=>nil}}, "test"=>{"twitter"=>{"enabled"=>false, "twitter_handle"=>"", "bearer_token"=>"", "twitter_picture"=>nil}}}
- * To have your bearer token created, run script in terminal being in the file of leap_web: `script/generate_bearer_token`
- * To have the script run properly you have to add before running: `--key your_consumerkey --secret your_consumersecret`
- * Add also `--projectroot your_projectroot --twitterhandle your_twitterhandle` as well to not have manually put the data in your secrets-file
- * The full command looks like this: `script/generate_bearer_token --key your_consumerkey --secret your_consumersecret --projectroot your_projectroot --twitterhandle your_twitterhandle`
- * If you didn't give all your information to the script, had a typo or want to change anything else, please do so by finding the secrets-file at `/config/secrets.yml`
- * Make sure that the correct twitterhandle and bearer-token is included
-
-* Deactivate your bearer token
- * To deactivate your generated bearer token you can run `script/invalidate_bearer_token`
- * The full command looks like this: `script/invalidate_bearer_token --key your_consumerkey --secret your_consumersecret --token your_bearer_token`