add docs dir.

1 files changed, 37 insertions, 0 deletions

diff --git a/docs/ROUTES b/docs/ROUTES
new file mode 100644
index 0000000..1dff148
--- /dev/null
+++ b/docs/ROUTES
@@ -0,0 +1,37 @@
+#+TITLE: PRESQUE ROUTES
+
+** GET /
+   "dashboard"
+
+** GET /q/:queue_name?worker_id
+   fetch a job from a queue
+
+** DELETE /q/:queue_name
+   delete a queue
+
+** POST /q/:queue_name
+   create a new job
+
+** PUT /q/:queue_name
+   mark a job as failed
+
+** GET /j/:queue_name
+   get some stats about a queue
+
+** GET /w/
+   get some stats for a queue
+
+** POST /w/:queue_name
+   register a worker on a queue
+
+** DELETE /w/:queue_name
+   unregister a worker on a queue
+
+** GET /status/:queue_name
+   get the size of a queue
+
+** GET /control/:queue_name
+   is the queue open or closed ?
+
+** POST /control/:queue_name
+   close or open a queue