/README.rdoc

 1= httparty
 2
 3Makes http fun again!
 4
 5== Note on Releases
 6
 7Releases are tagged on github and also released as gems on github and rubyforge. Master is pushed to whenever I add a patch or a new feature. To build from master, you can clone the code, generate the updated gemspec, build the gem and install.
 8
 9* rake gemspec
10* gem build httparty.gemspec
11* gem install the gem that was built
12
13== Note on Patches/Pull Requests
14
15* Fork the project.
16* Make your feature addition or bug fix.
17* Add tests for it. This is important so I don't break it in a future version unintentionally.
18* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself in another branch so I can ignore when I pull)
19* Send me a pull request. Bonus points for topic branches.
20
21== Features:
22
23* Easy get, post requests
24* Basic http authentication
25* Default request query string parameters (ie: for api keys that are needed on each request)
26* Automatic parsing of JSON and XML into ruby hashes based on response content-type
27
28== Examples
29
30See http://github.com/jnunemaker/httparty/tree/master/examples
31
32== Command Line Interface
33
34httparty also includes the executable <tt>httparty</tt> which can be
35used to query web services and examine the resulting output. By default
36it will output the response as a pretty-printed Ruby object (useful for
37grokking the structure of output). This can also be overridden to output
38formatted XML or JSON. Execute <tt>httparty --help</tt> for all the
39options. Below is an example of how easy it is.
40
41  httparty "http://twitter.com/statuses/public_timeline.json"
42
43== Requirements
44
45* multijson and multixml
46* You like to party!
47
48== Install
49
50* sudo gem install httparty
51
52== Docs
53
54http://rdoc.info/projects/jnunemaker/httparty