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

diff --git a/README b/README
index 23f1fa3..7d38e94 100644
--- a/README
+++ b/README
@@ -1,7 +1,17 @@
-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.
+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.