README.md in lita-wtf-1.0.1 vs README.md in lita-wtf-1.1.0
- old
+ new
@@ -17,12 +17,19 @@
gem "lita-wtf"
```
## Configuration
-None
+Optionally, you can add 'See Also' handlers
+```
+lita.config.wtf.see_also = ['merriam', 'urbandictionary']
+lita.config.wtf.api_keys = {
+ 'merriam': 'abc123'
+}
+```
+
## Usage
Set an entry:
```
@@ -35,8 +42,19 @@
```
lita wtf is foo
> foo is something that you want to have defined
```
-## License
+Optionally, get 'See Also' recommendations:
-[MIT](http://opensource.org/licenses/MIT)
+```
+lita wtf is foo
+> According to Merriam-Webster Collegiate Dictionary,
+> foo is a mythical lion-dog used as a decorative motif
+> in Far Eastern art
+> To replace this with our own definition, type: define foo is <description>.
+```
+
+## Development
+
+This project uses dotenv to load sensitive variables for development. Create
+a .env file in your local copy with "MERRIAM_KEY=<whatever key you use>"