X-Git-Url: http://www.git.cypherpunks.ru/?a=blobdiff_plain;f=README;h=719e1549487ac45a166dee0070a432e9fd9deabf;hb=ac9b31f3dfa1dbdf5c4571cfaf3c5b498faa0c0b;hp=8489c680b4a61d6637b8b6e0d94c7048c342e7ae;hpb=d2a8c845d659ec5b5dbda5e9c5207e7f09269c50;p=gorecfile.git

diff --git a/README b/README
index 8489c68..719e154 100644
--- a/README
+++ b/README
@@ -1 +1,14 @@
-GNU recutils'es recfile parser on pure Go.
+GNU recutils'es recfile parser/writer 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 (^+)
+
+Limitations:
+* leading spaces in the first line of the value are ignored
+* trailing backslash at the end of lines is followed by space
+
+It is free software: see the file COPYING for copying conditions.