README.md in NATO-0.0.3 vs README.md in NATO-0.1.0
- old
+ new
@@ -52,11 +52,11 @@
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'NATO'
+gem "NATO"
```
And then execute:
```
@@ -70,12 +70,42 @@
```
## Usage
```ruby
-text = Text.new 'a8h43lnr0'
+require "NATO"
+
+text = NATO::Text.new "a8h43lnr0"
text.to_nato # "Alfa Eight Hotel Four Three Lima November Romeo Zero"
text.pronunciation #'AL-FAH AIT HOH-TEL FOW-ER TREE LEE-MAH NO-VEM-BER ROW-ME-OH ZEE-RO'
+```
+
+Or, if you rather use refinements:
+```ruby
+require "NATO/refined"
+
+module YourApp
+ using NATO::Refined
+
+ "a8h43lnr0".to_nato # "Alfa Eight Hotel Four Three Lima November Romeo Zero"
+end
+```
+
+### Text-to-speach
+
+You can also use the text-to-speech system tool:
+```ruby
+require "NATO"
+
+NATO::Text.new("bzt").say # pipes out to "say" on mac or "espeak" on linux
+```
+
+### CLI
+
+```bash
+$ gem install nato
+$ nato --convert "bctz" # Bravo Charlie Tango Zulu
+$ nato --say "bctz" # uses system text-to-speech tool
```
## Contributing
1. Fork it