]> Cypherpunks.ru repositories - gorecfile.git/blobdiff - README
Slightly more documentation
[gorecfile.git] / README
diff --git a/README b/README
index 8489c680b4a61d6637b8b6e0d94c7048c342e7ae..23f1fa334fac2b85e98f796861e7615f9f5b6879 100644 (file)
--- a/README
+++ b/README
@@ -1 +1,7 @@
-GNU recutils'es recfile parser on pure Go.
+GNU recutils'es recfile parser on pure Go. recfiles are human-editable,
+plaintext databases. This library allows you to read records and their
+fields from it. Look for cmd/gorecsel as an example usage.
+
+* iterate through the records and their fields
+* ignore comments
+* support continuation lines (\$) and multilines (^+)