First commit with readme

1 files changed, 21 insertions, 0 deletions

diff --git a/readme.rst b/readme.rst
new file mode 100644
index 0000000..b9e788b
--- /dev/null
+++ b/readme.rst
@@ -0,0 +1,21 @@
+Simple Text Queue
+=================
+
+Why `tea` ???
+
+- Because I love tea.
+
+History
+=======
+
+Normally, if you have a worker writing to standard output every file
+processed, you could write something like this::
+
+    find -iname '*.ext' > queue.txt
+    cat queue.txt | worker > done.txt
+    # here you can interrupt the service at any time (Ctrl-C/SIGTERM)
+    comm -23 queue.txt done.txt > remaining_queue.txt
+
+But if this is something you want to do again and again, it might be
+convenient to write a little wrapper to do it for us. This is how teaqueue is
+born.