README.md in money_conversion_rates-0.1.1.2 vs README.md in money_conversion_rates-1.0
- old
+ new
@@ -1,17 +1,14 @@
# MoneyConversionRates
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/money_conversion_rates`. To experiment with that code, run `bin/console` for an interactive prompt.
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'money_conversion_rates'
+gem 'money_conversion_rates', '~> 1.0'
```
And then execute:
$ bundle
@@ -20,10 +17,46 @@
$ gem install money_conversion_rates
## Usage
-TODO: Write usage instructions here
+```ruby
+
+MoneyConversionRates::Money.conversion_rates('EUR', {
+ 'USD' => 1.11,
+ 'Bitcoin' => 0.0047
+})
+
+
+fifty_eur = MoneyConversionRates::Money.new(50, 'EUR')
+
+
+fifty_eur.amount # => 50
+fifty_eur.currency # => "EUR"
+fifty_eur.inspect # => "50.00 EUR"
+
+# Convert to a different currency (should return a Money
+# instance, not a String):
+
+fifty_eur.convert_to('USD') # => 55.50 USD
+
+# Perform operations in different currencies:
+
+twenty_dollars = MoneyConversionRates::Money.new(20, 'USD')
+
+
+# Comparisons (also in different currencies):
+
+twenty_dollars == MoneyConversionRates::Money.new(20, 'USD') # => true
+twenty_dollars == MoneyConversionRates::Money.new(30, 'USD') # => false
+
+fifty_eur_in_usd = fifty_eur.convert_to('USD')
+fifty_eur_in_usd == fifty_eur # => true
+
+twenty_dollars > MoneyConversionRates::Money.new(5, 'USD') # => true
+twenty_dollars < fifty_eur # => true
+
+```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.