From 0d21c1b74b7218a4f7a58cb0c42b89926c7b3583 Mon Sep 17 00:00:00 2001
From: mathieui <mathieui@mathieui.net>
Date: Sun, 6 May 2012 22:09:27 +0200
Subject: Add the missing plugin docs

---
 doc/en/plugins/reminder.txt | 76 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 76 insertions(+)
 create mode 100644 doc/en/plugins/reminder.txt

(limited to 'doc/en/plugins/reminder.txt')

diff --git a/doc/en/plugins/reminder.txt b/doc/en/plugins/reminder.txt
new file mode 100644
index 00000000..5fec9bd0
--- /dev/null
+++ b/doc/en/plugins/reminder.txt
@@ -0,0 +1,76 @@
+Reminder
+========
+
+Installation
+------------
+You only have to load the plugin:
+
+==============
+
+ /load reminder
+
+==============
+
+Usage
+-----
+This plugin defines three new global commands: _/remind_, _/done_, and
+_/tasks_.
+
+remind
+~~~~~~
+================
+
+ /remind <time> <todo>
+
+================
+
+Will remind you to do _<todo>_ every _<time>_.
+
+
+.Time in seconds
+================
+
+ /remind 600 Work!
+
+Will remind you to work every 10 minutes
+
+================
+
+Defining the time in seconds is not really usable, so you can describe it
+with days, hours, and minutes, e.g:
+
+.Time in a string
+=======================
+
+ /remind 1h23m "Get up"
+
+Will remind you to get up every 1 hour 23 minutes
+
+=======================
+
+
+done
+~~~~
+
+Removes a reminder.
+
+============
+
+ /done <id>
+
+===========
+
+The _id_ is found using _/tasks_.
+
+tasks
+~~~~~
+
+===============
+
+ /tasks
+
+================
+
+Will print a list of the tasks, their ids, and their frequency, into the
+information buffer.
+
-- 
cgit v1.2.3