1
0
Fork 0
mirror of https://github.com/jnunemaker/httparty synced 2023-03-27 23:23:07 -04:00
httparty/README
John Nunemaker dbb68d047d Added readme info on CLI interface.
Ensured that CLI defaults to ruby pp.
2009-01-05 02:03:37 -05:00

35 lines
No EOL
950 B
Text

= httparty
== DESCRIPTION:
Makes http fun again!
== FEATURES:
* Easy get, post requests
* Basic http authentication
* Default request query string parameters (ie: for api keys that are needed on each request)
* Automatic parsing of JSON and XML into ruby hashes based on response content-type
== EXAMPLES:
See http://github.com/jnunemaker/httparty/tree/master/examples
== COMMAND LINE INTERFACE
httparty also includes the executable <tt>httparty</tt> which can be
used to query web services and examine the resulting output. By default
it will output the response as a pretty-printed Ruby object (useful for
grokking the structure of output). This can also be overridden to output
formatted XML or JSON. Execute <tt>httparty --help</tt> for all the
options. Below is an example of how easy it is.
httparty "http://twitter.com/statuses/public_timeline.json" -f json
== REQUIREMENTS:
* JSON ~> 1.1
== INSTALL:
* sudo gem install httparty