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

diff --git a/README b/README
index 8489c68..23f1fa3 100644
--- 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 (^+)