README.md in urban_dictionary-0.0.2 vs README.md in urban_dictionary-1.0.0
- old
+ new
@@ -1,9 +1,11 @@
# Urban Dictionary #
`urban_dictionary` is a Ruby gem to access word definitions and examples from [Urban Dictionary](http://www.urbandictionary.com/). It also provides a command-line tool for getting definitions.
+[](https://travis-ci.org/ryangreenberg/urban_dictionary)
+
## Installation ##
Run `gem install urban_dictionary`.
## Usage ##
@@ -33,11 +35,23 @@
You can use the `--random` flag to get the definition of random word:
> urban_dictionary --random
+Specify the output format with `--format`. The default is `plain`; `json` is also supported.
+
+ > urban_dictionary --format=json one hundred | jq .
+ {
+ "word": "one hundred",
+ "entries": [
+ {
+ "definition": "keepin it real to the fullest and super tight.",
+ "example": "end of the convo\rLuke: aight man, peace\rQ: kool homie, keep it one hundred (100)"
+ },
+ ...
+ }
+
## Tests ##
Run examples with:
rspec
-