README.md in papla-0.0.1 vs README.md in papla-0.0.2
- old
+ new
@@ -1,19 +1,55 @@
-# Papla
+# Papla [](http://travis-ci.org/exviva/papla)
Papla is a Ruby gem that allows you to convert numbers into Polish words (e.g. `153` into `"sto pięćdziesiąt trzy"`), including the decimal part as cents and currency symbol. Its primary use case are invoices, where the total amount has to be displayed as words at the bottom line.
-## Basic examples
+## Installation
+To install Papla, run
+
+ gem install papla
+
+or add
+
```ruby
-Papla[158] # => 'Sto pięćdziesiąt'
-Papla[1_234] # => 'Tysiąc dwieście trzydzieści cztery'
-Papla[987_654_321] # => 'Dziewięćset osiemdziesiąt siedem milionów sześćset pięćdziesiąt cztery tysiące trzysta dwadzieścia jeden'
+gem 'papla'
```
-## Cents and currency
+to your `Gemfile`.
+## Usage
+
+### Basic examples
+
+```ruby
+Papla[158] # => "Sto pięćdziesiąt osiem"
+Papla[1_234] # => "Tysiąc dwieście trzydzieści cztery"
+Papla[987_654_321] # => "Dziewięćset osiemdziesiąt siedem milionów sześćset pięćdziesiąt cztery tysiące trzysta dwadzieścia jeden"
+```
+
+### Cents and currency
+
+#### Cents
+
+When given a `Float`, Papla will assume that the decimal part represents cents.
+It will then round the number using `Float#round` to two decimal places,
+and append the number of cents divided by hundred to the resulting string.
+
+Example:
+
+```ruby
+Papla[1.0] # => "Jeden 00/100"
+Papla[87.654321] # => "Osiemdziesiąt siedem 65/100"
+Papla[2.999] # => "Trzy 00/100"
+```
+
+#### Currency
+
This feature is planned for future releases.
-## Integration with Money, I18n and Rails
+### Integration with Money, I18n and Rails
This feature is planned for future releases.
+
+## Documentation
+
+Documentation is available at [RubyDoc.info](http://rubydoc.info/github/exviva/papla/master/frames).