Permalink
Browse files

Updated the README

  • Loading branch information...
Jorge Vargas
Jorge Vargas committed Sep 26, 2012
1 parent 9cc3026 commit efd3bc128f2ec9e7f88841521e42664b94376ddc
Showing with 6 additions and 6 deletions.
  1. +6 −6 README.md
View
@@ -3,7 +3,7 @@
[Ruby Carrot](https://github.com/VoiceBunny/ruby-carrot) is a Ruby library that provides connection to the [VoiceBunny.com](http://voicebunny.com) HTTP RESTful API, using the library [Faraday](https://github.com/technoweenie/faraday) for the HTTP request/response cycle.
If you need more information on how to use our library check the [installation guide](https://github.com/VoiceBunny/ruby-carrot/wiki/installation) or the [tutorial](https://github.com/VoiceBunny/ruby-carrot/wiki/Use-tutorial).
-### Usage
+## Usage
```ruby
# Imports
@@ -36,19 +36,19 @@ response.to_yaml
puts response['projects']
```
-### Request a VoiceBunny API Token
+## Request a VoiceBunny API Token
To use this library you need to request an API Token in the [VoiceBunny.com Developer's Section](http://voicebunny.com/developers/token).
-### TODO
+## TODO
* migrate the tests to Stubs instead of text files mocked JSON responses
* update the tests
-### Contributing
+## Contributing
Feel free to fork our gem or add a pull request
-### Don't you like Ruby?
+## Don't you like Ruby?
If you're not confortable with Ruby language, you can also check our other libraries:
* [Python Carrot](https://github.com/VoiceBunny/python-carrot)
@@ -57,6 +57,6 @@ If you're not confortable with Ruby language, you can also check our other libra
Or why not, build your own library from scratch checking the [API documentation](http://voicebunny.com/developers/index).
-### Copyright
+## Copyright
Copyright (c) 2008 Torrenegra IP, LLC. Distributed under Creative Commons [CC-BY license](http://creativecommons.org/licenses/by/3.0/).

0 comments on commit efd3bc1

Please sign in to comment.