From 46b03de3685b8714f97013d435a337ba4c0eaa8e Mon Sep 17 00:00:00 2001 From: Oskari Timperi Date: Wed, 25 Oct 2017 22:00:27 +0300 Subject: initial commit --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000..89c1871 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Rec file parser for Nim + +Using this library you can parse rec files made by the +[recutils][https://www.gnu.org/software/recutils/] software. + +# Examples + +If you have the following recfile: + +``` +Name: John Doe +Age: 34 + +Name: Jane Doe +Age: 32 +``` + +You can read the names of the persons like this: + +```nim +import nimrec +import streams + +for record in records(newFileStream("persons.rec")): + echo(record["Name"]) +``` + +More examples can be found in the `examples` directory. -- cgit v1.2.3