dbot/modules-stock/words/README.md
Georg 70a21d2b18
Signed-off-by: Georg <georg@lysergic.dev>
Init

- Initial fixes in modules
- Bundled adapted jsbot
- Elaborative README.md
2021-08-24 21:16:26 +02:00

41 lines
778 B
Markdown

## words
Adds various functionality for words.
### Description
This module provides commands which allows users to have various functionality for words,
such as defining, getting the etymology and jimble the letters.
To achieve that, this module seeks the wordnik database.
### Dependencies
It has following dependencies:
+ [node-wordnik](https://github.com/cpetzold/node-wordnik)
### config.json
api_key : most likely the wordnik developer homepage
### Commands
#### ~define [word]
Seeks wordnik database and replys with a definition.
Example:
+ ~define Spaghetti
#### ~etymology [word]
Seeks wordnik database and replys with its etymology.
Example:
+ ~etymology Spaghetti
#### ~jimble [word]
Jimbles the letters of a word.
Example:
+ ~jimble Spaghetti
### TODO