diff plugins/ask/ask.md @ 0:1158cffe5a5e

Initial import
author David Demelier <markand@malikania.fr>
date Mon, 08 Feb 2016 16:43:14 +0100
parents
children 8384df86e195
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/plugins/ask/ask.md	Mon Feb 08 16:43:14 2016 +0100
@@ -0,0 +1,37 @@
+---
+title: "Ask plugin"
+header: "Ask plugin"
+---
+
+The plugin **ask** is funny script that help you in your life. It will tell you if you will be rich, famous and so on.
+
+## Installation
+
+The plugin **ask** is distributed with irccd. To enable it add the following to your `plugins` section:
+
+````ini
+[plugins]
+ask = ""
+````
+
+## Usage
+
+The plugin **ask** reacts to special command, you just need to do `!ask the question` and it will give you a response.
+
+Example:
+
+    markand: !ask will I be rich?
+    irccd: markand, No.
+
+## Configuration
+
+By default, **ask** will only answer yes or no. It's possible to add any answers you want in the file **answers.conf**
+located in the ask configuration directory.
+
+Just add one line per answer like this:
+
+**~/.local/config/irccd/plugin/ask/answers.txt**:
+
+    Stop dreaming,
+    Definitely sure!
+    Maybe