README.md in urban_dictionary-0.0.1 vs README.md in urban_dictionary-0.0.2
- old
+ new
@@ -6,11 +6,11 @@
Run `gem install urban_dictionary`.
## Usage ##
-Get words using `UrbanDictionary.define` or `UrbanDictionary.random_word`. These methods return an instance of UrbanDictionary::Word, which has a list of entries. Each entry has a definition and an example.
+Get words using `UrbanDictionary.define` or `UrbanDictionary.random_word`. These methods return an instance of UrbanDictionary::Word, which has a list of entries, or nil if the word is not found. Each entry has a definition and an example.
require 'urban_dictionary'
word = UrbanDictionary.define("QED")
word.entries.size # => 7
@@ -31,6 +31,13 @@
...
...
You can use the `--random` flag to get the definition of random word:
- > urban_dictionary --random
\ No newline at end of file
+ > urban_dictionary --random
+
+## Tests ##
+
+Run examples with:
+
+ rspec
+