# HG changeset patch
# User Mathias Gebbe <mgebbe@intevation.de>
# Date 1402518860 -7200
# Node ID 8363d4970c75cfb937d976c1e4fa98984f96236c
# Parent  6fd0a307850f3c255cd5bbfeab7dcac750e49d22
changed README and added twitter to pumpbridge.json.example

diff -r 6fd0a307850f -r 8363d4970c75 README.md
--- a/README.md	Wed Jun 11 21:58:41 2014 +0200
+++ b/README.md	Wed Jun 11 22:34:20 2014 +0200
@@ -2,35 +2,98 @@
 
 connects pump.io to facebook and googleplus
 
-### Features
+THIS SOFTWARE IS A PROOF OF CONCEPT DEMONSTRATION
 
-####g+
+## Features
+
+###g+ (read only)
 
 * get all public posts from your circles
   and convert it to pump notes
   (text, links, pics, videos)
 
-####facebook
+###facebook (read / write)
 
-* get facebook newsfeed
+* get facebook newsfeed including some non-public posts
+  depending on your friends privacy configuration
   (text, links, pics, videos)
 
-* post public pump posts to facebook
+* post public pump posts and public shares to facebook
 
 * likes and comments to facebook related pump notes
   are synced to facebook
 
-#### twitter
-
-* get tweets from all you follow and post them to pump.io
+###twitter (read / write)
 
-* post public pump posts to twitter (max 140 characters)
+* get all tweets and retweets of the people you're following on twitter
 
-####benefits
+* post public pump posts and public shares to twitter
 
-* share googleplus posts to facebook and pump.io
+###benefits
 
-## License
+* share posts between networks.
+  For example, you can share a post from googleplus/facebook/twitter to your followers in pump.io.
+
+##start bridging
+
+* login to a remote pump.io account to get started
+
+* check your pump.io id (logged in as:)
+
+* login to your established social network:
+
+    * Twitter:
+        * click on Twitter icon
+        * login
+        * your account will be synced immediately
+          and you got all posts within the last interval (default 15min)
+
+    * Facebook:
+        * click on Facebook icon
+        * login
+        * click save credentials
+        * your account will be synced to the next interval (default 15min)
+        * pumpbridge syncs your public pump.io posts you made within the last interval
+        * pumpbridge syncs facebooks posts within the last interval
+          (depending on timezone it differs a little bit)
+
+    * Googleplus:
+        * click on Google icon
+        * login
+        * click save credentials
+        * your account will be synced to the next interval (default 15min)
+        * pumpbridge syncs google posts within the last interval
+          (since g+-api is read only you can not post to googleplus)
+
+* click save credentials
+
+* logout
+
+##stop bridging
+
+* login to a remote pump.io account
+
+* click on delete credentials on the specify social network
+  (in certain circumstances you still see your loginname even
+  if all token were deleted)
+
+#Video
+
+https://www.youtube.com/watch?v=SB2CGFnrnLY (older version without )
+
+#SSL
+
+see https://github.com/e14n/pump.io/wiki/StartSSL-Free-Certificate
+
+#Bugs
+
+#To-Do and wishlist
+
+* sync comments from googleplus to pump.io
+* sync comments from facebook to pump.io
+* sync comments from pump.io to facebook
+
+# License
 
 Copyright (C) 2014
 Intevation GmbH <intevation@intevation.de>
@@ -52,11 +115,11 @@
 See the License for the specific language governing permissions and
 limitations under the License.
 
-#####Authors
+##Authors
 
 Mathias Gebbe <mgebbe@intevation.de>
 
-#####Media
+##Media
 
 * bridge (bridge.png): http://commons.wikimedia.org/wiki/File:Bridge-stone.svg
 * facebook (fb.svg): http://commons.wikimedia.org/wiki/File:F_icon.svg
@@ -64,10 +127,11 @@
 * pump.io (pumpiologo.svg): https://en.wikipedia.org/wiki/Pump.io#mediaviewer/File:Pump.io.svg
 * background (grey_wash_wall.png): http://subtlepatterns.com/grey-washed-wall/ (CC BY-SA 3.0)
 
-#####Sources
+##Sources
 
 The source files can be check out as follows
 ```
 hg clone https://hg.wald.intevation.org/pumpbridge/
 ```
-parts from https://github.com/e14n/pump2status are used!
+this software is based on https://github.com/e14n/pump2status and
+uses many tools from https://github.com/e14n/
diff -r 6fd0a307850f -r 8363d4970c75 pumpbridge.json.example
--- a/pumpbridge.json.example	Wed Jun 11 21:58:41 2014 +0200
+++ b/pumpbridge.json.example	Wed Jun 11 22:34:20 2014 +0200
@@ -19,6 +19,8 @@
 "gpCLIENTSECRET": "THEGOOGLECLIENTSECRET",
 "fbAPPID": "FACEBOOKAPPID",
 "fbSECRET": "FACEBOOKSECRET",
+"twclient_id": "TWITTERAPIKEY",
+"twclient_secret": "TWITTERSECRET",
 "key": "/etc/ssl/server.key",
 "cert": "/etc/ssl/server.pem"
 }