Update README.md

README.md

@@ -52,3 +52,48 @@ Modify it thusly, then feed it to the script:
 [https://www.youtube.com/**rss**/channel/UCQzdMyuz0Lf4zo4uGcEujFw/**feed.rss**](https://www.youtube.com/rss/channel/UCQzdMyuz0Lf4zo4uGcEujFw/feed.rss)
 
 If you'd want Diaspora to automatically embed the video, you must also pass the `--post-raw-link` argument
+
+# pod_tweeter
+Publishes twitter feeds to Diaspora*
+
+This is a lightweight, customizable "bot" script to harvest twitter feeds and re-publish them to the Diaspora social network. It is posted here without warranty, for public use.
+
+## Installation
+
+ You must have the following perl modules installed:
+
+- LWP::UserAgent
+- URI::Escape
+- HTML::Entities
+- JSON
+- DBD::SQLite
+- Unicode::Normalize
+- Getopt::Long
+- Net::Twitter::Lite::WithAPIv1_1
+- DateTime
+
+This script is intended to be run as a cron job, which might look something like this:
+
+`@hourly  ~/pod_tweeter.pl --timeline-id mytimeline --screen-name\@AesopRockWins --access-token beefbeefbeefbeef --access-token-secret feedfeedfeedfeed --consumer-token effeffeffeff --consumer-secret 0e0e0e0efff --pod-url https://diaspora.hzsogood.net --username user --password supersecretpassword > /dev/null 2>&1`
+
+## Usage
+
+    -a   --aspect-id <id>                Aspects to share with. May specify multiple times (default: 'public')
+    -c   --consumer-key <string>         The twitter API consumer key
+    -d   --database <sqlite file>        The SQLite file to store feed data (default: 'feed.db')
+    -e   --access-token-secret <string>  The twitter API access token secret
+    -i   --timeline-id <string>          An arbitrary identifier to associate database entries with this feed
+    -k   --access-token <string>         The twitter API access token
+    -l   --pod-url <https://...>         The pod URL
+    -m   --timeout <hours>               How long (in hours) to keep attempting failed posts (default: 72)
+    -o   --fetch-only                    Don't publish to Diaspora, just queue the new feed items for later
+    -p   --password <********>           The D* user password
+    -r   --consumer-secret <string>      The twitter API consumer secret
+    -s   --screen-name <@screenname>     The twitter feed to scrape (default: the user associated with the API keys)
+    -t   --auto-tag <#hashtag>           Hashtags to add to all posts. May be specified multiple times (default: none)
+    -u   --username <user>               The D* login username
+    -x   --limit <n>                     Only post n items per script run, to prevent post-spamming (default: no limit)
+
+## Note
+
+In order to use this script, you must have a twitter developer account, create an "app" and generate the necessary tokens and secret keys. See https://apps.twitter.com