Merge remote-tracking branch 'pr/239' into develop

1 files changed, 20 insertions, 2 deletions

diff --git a/doc/TWITTER_FEED.md b/doc/TWITTER_FEED.md
index dd3954c..6deb432 100644
--- a/doc/TWITTER_FEED.md
+++ b/doc/TWITTER_FEED.md
@@ -19,12 +19,29 @@ LEAP web app (as part of the main view).
 * 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}}}
+```
+development:
+  twitter:
+    enabled: false # set to true for usage
+    twitter_handle: XXXXX #put your twitter handle here
+    bearer_token: XXXXX #put your bearer token here
+test:
+  twitter:
+    enabled: false # set to true for usage
+    twitter_handle: XXXXX #put your twitter handle here
+    bearer_token: XXXXX #put your bearer token here
+production:
+  twitter:
+    enabled: false # set to true for usage
+    twitter_handle: XXXXX #put your twitter handle here
+    bearer_token: XXXXX #put your bearer token here
+```
   * 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
+  * Make sure that the correct twitter-handle and bearer-token is included. The account's tweets must not be protected, otherwise they cannot be displayed.
 
 * Deactivate your bearer token
   * To deactivate your generated bearer token you can run script/invalidate_bearer_token
@@ -32,4 +49,5 @@ LEAP web app (as part of the main view).
 
 ### Default avatar image ###
 
-This feature uses by default the twitter bird as avatar picture (Twitter_Logo_Blue.png). By using the Twitter trademarks, you agree to follow the Twitter Trademark Guidelines as well as Twitter's Terms of Service and all other Twitter rules and policies. Please find more details here: https://brand.twitter.com/.
+This feature uses by default the twitter bird as avatar picture, you can find here (app/assets/images/Avatar_Pic.png). For customization you can upload your own avatar picture to 'config/customization/images' naming the image file 'Avatar_Pic.png'. This will replace the default image file.
+By using the Twitter trademarks, you agree to follow the Twitter Trademark Guidelines as well as Twitter's Terms of Service and all other Twitter rules and policies. Please find more details here: https://brand.twitter.com/.