Add a README

[rfc1751] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..93cdb90
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# rfc1751
+
+Convert between numbers and rfc1751 word-lists:
+
+    $ rfc1751 6582857583
+    NICE EASY TOOL
+
+    $ rfc1751 NICE EASY TOOL
+    6582857583
+
+Or as a library:
+
+    >>> import rfc1751
+
+    >>> rfc1751.decode('FROM CODE TOO'.split())
+    4523180557
+
+    >>> rfc1751.encode(4523180557)
+    ['FROM', 'CODE', 'TOO']