Changeset 443eea1


Ignore:
Timestamp:
Sep 16, 2009, 11:06:50 PM (12 years ago)
Author:
Nelson Elhage <nelhage@mit.edu>
Branches:
master, release-1.7, release-1.8, release-1.9
Children:
9eb9479
Parents:
f0de278
git-author:
Nelson Elhage <nelhage@mit.edu> (09/16/09 22:20:19)
git-committer:
Nelson Elhage <nelhage@mit.edu> (09/16/09 23:06:50)
Message:
Reformat README.

Try to make it more organized, and add a clear SYNOPSIS section with
minimal getting-started instructions.
File:
1 edited

Legend:

Unmodified
Added
Removed
  • README

    ra3874bce r443eea1  
    1 The Twitter module implements Twitter support for BarnOwl. It also
    2 supports automatic mirroring of some subset of Zephyrs you send to
    3 Twitter.
     1NAME
     2  Twitter.par - Twitter support for BarnOwl
    43
    5 To configure it, first
     4DESCRIPTION
     5  The Twitter module implements Twitter support for BarnOwl. It also
     6  supports automatic mirroring of some subset of Zephyrs you send to
     7  Twitter.
    68
    7 * Add your twitter credentials to ~/.owl/twitter as a JSON hash, e.g.
    8 {"user":"nelhage", "password":"sekrit" }
    9 * Load the module (cp Twitter.par into ~/.owl/modules and :reload-module Twitter)
    10 * Set the twitter:class, twitter:instance, and twitter:opcode
    11   variables to the destination you want messages to be mirrored
    12   from. By default, they are -c $YOUR_USERNAME -i status -O twitter
     9SYNOPSIS
     10  (1) Configure your Twitter credentials in ~/.owl/twitter in the
     11  following format:
     12----------8<----------cut here----------8<----------
     13{
     14 "user":"nelhage",
     15 "password":"sekrit"
     16}
     17----------8<----------end cut ----------8<----------
     18  (2) Copy Twitter.par into ~/.owl/twitter
     19  (3) Run ":reload-module Twitter" inside BarnOwl
     20  (4) Start receiving tweets in BarnOwl!
     21      You can send tweets with the ":twitter" command.
     22
     23MIRRORING ZEPHYRS TO TWITTER
     24  If you set the twitter:class, twitter:instance, and twitter:opcode
     25  BarnOwl variables, BarnOwl will resend zephyrs matching those fields
     26  as tweets coming from you.
     27
     28  By default, these default to -c $YOUR_USERNAME -i status -O twitter.
    1329  Setting twitter:opcode to "" will cause "normal" (i.e. no opcode)
    14   messages to that class/instance to be mirrored. A value of '*'
    15   works as a "match-anything" wildcard for any of the fields.
     30  messages to that class/instance to be mirrored. A value of '*' works
     31  as a "match-anything" wildcard for any of the fields.
    1632
    17 Twitter.par will also receive twitters and inject them into barnowl as
    18 messages of type 'twitter'. It polls for normal messages once a
    19 minute, and direct messages every other minute. To disable polling,
    20 you can unset the 'twitter:poll' variable in BarnOwl.
     33POLLING
     34  Twitter.par polls for normal messages once a minute, and direct
     35  messages every other minute. To disable polling, you can unset the
     36  'twitter:poll' variable in BarnOwl.
    2137
    22 Twitter.par now supports other Twitter-compatible microblogging
    23 services, like identi.ca. To enable this, set the 'service' parameter
    24 in your config hash to the API URL of your service. You will likely
    25 also need to set 'apihost' and 'apirealm'. See Net::Twitter or your
    26 blogging service's documentation for more information.
     38IDENTI.CA SUPPORT
     39  Twitter.par supports other Twitter-compatible microblogging services,
     40  like identi.ca. To enable this, set the 'service' parameter in your
     41  config hash to the API URL of your service. You may also need to set
     42  'apihost' and 'apirealm'. See Net::Twitter or your blogging service's
     43  documentation for more information.
    2744
    28 Twitter.par also supports using multiple Twitter and Twitter-compatible
    29 microblogging accounts from the same instance.  To enable this, add
    30 additional hashes to your ~/.owl/twitter file as a JSON list, e.g.
     45MULTIPLE ACCOUNTS
     46
     47  Twitter.par also supports using multiple Twitter and
     48  Twitter-compatible microblogging accounts from the same instance.
     49  To enable this, add additional hashes to your ~/.owl/twitter file as
     50  a JSON list, e.g.
    3151----------8<----------cut here----------8<----------
    3252[
     
    5373  }
    5474]
    55 ----------8<----------cut here----------8<----------
     75----------8<----------end cut ----------8<----------
    5676
    5777Outgoing tweets sent via ":twitter" without an explicit sender, or
     
    91111    published to this account.
    92112
     113    If only one account is specified, it defaults to publish_tweets =
     114    true.
     115
    93116* show_mentions (boolean, default true)
    94117    If true, BarnOwl will show all tweets that mention this account's
Note: See TracChangeset for help on using the changeset viewer.