Changeset 159aaad for README

Timestamp:

Jul 21, 2009, 9:27:32 PM (15 years ago)

Author:

Nelson Elhage <nelhage@mit.edu>

Branches:

master, release-1.10, release-1.7, release-1.8, release-1.9

Children:

7430aa4

Parents:

f93b81b

git-author:

Kevin Riggle <kevinr@free-dissociation.com> (07/21/09 21:27:02)

git-committer:

Nelson Elhage <nelhage@mit.edu> (07/21/09 21:27:32)

Message:

Multiple account support

Accounts are specified as a list of hashes in the ~/.owl/twitter file.

Adds 'poll_for_tweets', 'poll_for_dms', 'publish_tweets', 'default_sender',
and 'account_nickname' options to the twitter account hashes.  They do about
what they say on the tin.

Add arguments to :twitter, :twitter-direct, and :twitter-atreply to specify
the service to use (by nickname), with sane defaults, plus documentation.

File:

• README (modified) (1 diff)

README

@@ -25 +25 @@
 also need to set 'apihost' and 'apirealm'. See Net::Twitter or your
 blogging service's documentation for more information.
+
+Twitter.par also supports using multiple Twitter and Twitter-compatible
+microblogging accounts from the same instance.  To enable this, add 
+additional hashes to your ~/.owl/twitter file (wrapped in a JSON list,
+eg. [{"account_nickname":"twitter","user":"nelhage","password":"sekrit"},
+{"account_nickname":"identica","service":"http://identi.ca/api",
+"user":"nelhage","password":"sekriter"}]
+
+By default, public messages (excluding at-replies) are sent to all 
+accounts listed except those with publish_tweets set to false.
+
+There are several additional account-specific parameters that control the 
+behavior of Twitter.par when using multiple accounts:
+
+* account_nickname (string, required if multiple accounts are in use)
+    Specify a short name by which you can refer to the account, eg.
+    "identica" (eg. :twitter-direct nelhage identica would send a direct 
+    message to @nelhage on identi.ca from your account nicknamed "identica").
+* default_sender (boolean, default false)
+    If true, direct messages and at-replies you send without specifying an
+    account will be sent using this account.  If no account has this parameter,
+    such messages will be sent using the first account listed.
+* poll_for_tweets (boolean, default true)
+    If true, tweets sent by your friends on this account will be displayed
+    in your BarnOwl message list.
+* poll_for_dms (boolean, default true)
+    If true, Direct Messages sent to you by your friends on this account 
+    will be displayed in your BarnOwl message list.
+* publish_tweets (boolean, default true)
+    If true, tweets you send without specifying an account (either with the 
+    :twitter command or mirrored from a zephyr class) will be published to 
+    this account.