initial commit

1 files changed, 28 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..89c1871
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Rec file parser for Nim
+
+Using this library you can parse rec files made by the
+[recutils][https://www.gnu.org/software/recutils/] software.
+
+# Examples
+
+If you have the following recfile:
+
+```
+Name: John Doe
+Age: 34
+
+Name: Jane Doe
+Age: 32
+```
+
+You can read the names of the persons like this:
+
+```nim
+import nimrec
+import streams
+
+for record in records(newFileStream("persons.rec")):
+    echo(record["Name"])
+```
+
+More examples can be found in the `examples` directory.