README.md in currency_converter-0.0.1 vs README.md in currency_converter-0.0.2
- old
+ new
@@ -16,14 +16,29 @@
$ gem install currency_converter
## Usage
-TODO: Write usage instructions here
+To convert between two currencies:
+ CurrencyConverter.exchange("EUR", "USD", 100)
+ => 132.89
+
+ CurrencyConverter.exchange("USD", "EUR", 100)
+ => 75.15
+
+To get the most recent exchange rate between two currencies:
+
+ CurrencyConverter.exchange("EUR", "USD", 1)
+ => 1.33
+
+ CurrencyConverter.exchange("USD", "EUR", 1)
+ => 0.75
+
## Contributing
1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+2. Add tests for it.
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request