mirror of
https://github.com/jnunemaker/httparty
synced 2023-03-27 23:23:07 -04:00
Renamed readme and tweaked it.
This commit is contained in:
parent
8da360fb4d
commit
1fdccf99e0
1 changed files with 18 additions and 8 deletions
|
@ -1,21 +1,31 @@
|
|||
= httparty
|
||||
|
||||
== DESCRIPTION:
|
||||
|
||||
Makes http fun again!
|
||||
|
||||
== FEATURES:
|
||||
== Note on Releases
|
||||
|
||||
Releases 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 and run 'rake install' to install the gem.
|
||||
|
||||
== Note on Patches/Pull Requests
|
||||
|
||||
* Fork the project.
|
||||
* Make your feature addition or bug fix.
|
||||
* Add tests for it. This is important so I don't break it in a future version unintentionally.
|
||||
* 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)
|
||||
* Send me a pull request. Bonus points for topic branches.
|
||||
|
||||
== 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:
|
||||
== Examples
|
||||
|
||||
See http://github.com/jnunemaker/httparty/tree/master/examples
|
||||
|
||||
== COMMAND LINE INTERFACE
|
||||
== 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
|
||||
|
@ -26,15 +36,15 @@ options. Below is an example of how easy it is.
|
|||
|
||||
httparty "http://twitter.com/statuses/public_timeline.json"
|
||||
|
||||
== REQUIREMENTS:
|
||||
== Requirements
|
||||
|
||||
* Crack http://github.com/jnunemaker/crack/ - For XML and JSON parsing.
|
||||
* You like to party!
|
||||
|
||||
== INSTALL:
|
||||
== Install
|
||||
|
||||
* sudo gem install httparty
|
||||
|
||||
== DOCS:
|
||||
== Docs
|
||||
|
||||
http://rdoc.info/projects/jnunemaker/httparty
|
Loading…
Add table
Reference in a new issue