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

diff --git a/README b/README
index 8489c68..7d38e94 100644
--- a/README
+++ b/README
@@ -1 +1,17 @@
-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
+
+Also there is go.cypherpunks.ru/recfile/slog.NewRecfileHandler log/slog
+handler to write your logs in recfile format directly.
+
+It is free software: see the file COPYING for copying conditions.