Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update readme to markdown formatting

  • Loading branch information...
commit e80cbc553cb9d295f849d665455084fdb97d13ee 1 parent 020d6bc
@jnunemaker authored
Showing with 23 additions and 26 deletions.
  1. +23 −26 README.md
View
49 README.md
@@ -1,27 +1,23 @@
-= httparty
+# httparty
Makes http fun again!
-== Features:
+## Install
-* 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
+```
+gem install httparty
+```
-== Examples
+## Requirements
-See http://github.com/jnunemaker/httparty/tree/master/examples
+* multijson and multixml
+* You like to party!
-== Note on Patches/Pull Requests
+## Examples
-* 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.
+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
@@ -30,18 +26,19 @@ 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"
-
-== Requirements
-
-* multijson and multixml
-* You like to party!
-
-== Install
+```
+httparty "http://twitter.com/statuses/public_timeline.json"
+```
-* sudo gem install httparty
-
-== Help and Docs
+## Help and Docs
* https://groups.google.com/forum/#!forum/httparty-gem
* http://rdoc.info/projects/jnunemaker/httparty
+
+## Contributing
+
+* 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.
Please sign in to comment.
Something went wrong with that request. Please try again.