= twtr
* twtr.rubyforge.org

== DESCRIPTION:
twtr is a twitter client for Linux, OSX and Windows Console.

== DESCRIPTION:
twtr is a imprementaion of twitter client.
Features are
* Command line application.
* Simple Twitter library.
* Http Proxy available.
* Double Byte Encoding. e.g) ShiftJIS, EUC-JP, etc.

== SYNOPSIS:
* command line
twtr [subcommand] [options]
ex)
$ twtr setting # => (Re)set config file.
$ twtr ft # => Show friends timeline.
$ twtr pt -P 2 # => Show public timeline (page 2).
$ twtr ut -i bob # => Show someone's timeline.
$ twtr rp # => Show replies.
$ twtr up -m "hello world" # => Update message.

* ruby code
require "twtr"
tc = Twtr::Client.new(
"account" => => "bob", "password" => "secret",
"proxy" => => "proxy.domain", "port" => 8080,
)

result_json = tc.update(=> "hello world! from twtr", :format => :json)

result_xml = tc.friends_timeline(=> 2, :format => :xml)


== SUBCMMAND:
setting (reset) # (Re)Set twtr configuration info.
friends_timeline (ft) # Show friends timeline.
putlic_timeline (pt) # Show public timeline.
user_timeline (ut) # Show user timeline. -i, --id option required.
replies (rp) # Show replies.
update (up) # Updates your status. -m, --message option required.


* twtr lib.
require "twtr"
tc = Twtr::Client.new(
Twtr::Config.load("/path/to/twtr.yml")
)

tc.message("hello!")
#=> [[foo, "hello1"]]

tc.timeline(:friends)
#=> [["foo", "hello!"],["bar","what's up?"],["bar","I'm Home."]]

tc.timeline(:timeline)
#=> [["superman", "hello!"],["badman","what's up?"],["ultraman","I'm Home."],["foo","hello!"]]


== INSTALL:

* gem install twtr

== LICENSE:

(The MIT License)

Copyright (c) 2008 Ryota Maruko

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.