README.md in rdice-0.0.3 vs README.md in rdice-0.0.4
- old
+ new
@@ -1,24 +1,24 @@
-# Dice
+# RDice [](http://travis-ci.org/detierno/dice)
-This gem was created with studies purpose. It simple create a dice and let you roll one or more dices with different faces.
+This gem was created with studies purpose. It simple create a dice and let you roll one or more dices with different sides.
## Installation
Add to your Gemfile and run the `bundle` command to install it.
```ruby
gem "rdice"
```
-**Requires Ruby 1.9.3 or later.**
+**Tested with Ruby 1.9.3**
## Usage
-Them most basic use you can create a new instance of Dice and perform some rolls
+Them most basic use you can create a new instance of Dice and perform some rolls. The returned value is a integer containing the sum of all dices rolled
```ruby
dice = Dice.new
dice.roll
@@ -32,15 +32,20 @@
If you call roll with only the number of times you want to roll it will roll the default dice with the required number of times
## Changing the defaults
-When you call *.roll* method this roll a dice with the defaults faces and dices number (6 and 1). If you want to change the defaults you can in the class creation
+When you call *.roll* method this roll a dice with the defaults sides and dices number (6 and 1). If you want to change the defaults you can in the class creation
```ruby
dice = Dice.new(20,2)
-dice.roll # will roll two d20 by default
+dice.roll # rolls two d20 by default
+dice.roll_two # rolls two d20
+dice.roll_four # rolls four d20
+dice.roll_d20 # rolls two d20
+dice.roll_three_d8 # rolls three d8
+dice.roll_10_d3 # rolls 10 d3
```
## License
Ruby on Rails is released under the MIT license:
\ No newline at end of file