Changeset cdb546f for README

Timestamp:

Mar 6, 2009, 1:58:24 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:

bab79f8

Parents:

706ff88

Message:

Update the README.

File:

• README (modified) (3 diffs)

README

@@ -1 @@
-The Twitter modules automatically mirrors selected zephyrs to your
-personal class to your twitter feed.
+The Twitter module implements Twitter support for BarnOwl. It also
+supports automatic mirroring of some subset of Zephyrs you send to
+Twitter.
 
 To configure it, first
@@ -6 +7 @@
 * Add your twitter credentials to ~/.owl/twitter as a JSON hash, e.g.
 {"user":"nelhage", "password":"sekrit" }
-* Load the module
+* Load the module (cp Twitter.par into ~/.owl/modules and :reload-module Twitter)
 * Set the twitter:class, twitter:instance, and twitter:opcode
   variables to the destination you want messages to be mirrored
@@ -14 +15 @@
   works as a "match-anything" wildcard for any of the fields.
 
-As of Thanksgiving weekend 2008, Twitter.par will also receive
-twitters and inject them into barnowl as messages of type
-'twitter'. Currently, it polls every 45 seconds, and there's no way to
-disable polling once loaded. There's also no direct message
-support. Bug me if fixing any of these is important to you.
+Twitter.par will also receive twitters and inject them into barnowl as
+messages of type 'twitter'. It polls for normal messages once a
+minute, and direct messages every other minute. To disable polling,
+you can unset the 'twitter:poll' variable in BarnOwl.