commit 9331e8389e0d7df0fc7c5c00e8c3aedbacfb6034
parent e9f43b99697f97c236b6034583972f2d7583f92f
Author: Byron Torres <b@torresjrjr.com>
Date: Wed, 4 Aug 2021 09:17:17 +0100
Update README.md
Diffstat:
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
@@ -4,9 +4,11 @@ go-nestedtext
[NestedText v1][1]\* in Go (alpha).
Provides an executable which converts stdin NestedText to stdout JSON.
-Future plans are to provide a simple library.
+Future plans are to provide a `jq` like interface and a simple library.
+
+\* This implementation does not recognise quoted or multi-lined keys,
+in the interest of simplicity against needless complexity.
-\* This implementation does not recognise quoted or multilined keys.
Build
-----
@@ -18,7 +20,7 @@ Usage
-----
$ nt < data.nt
- $ nt <<.
+ $ nt <<EOF
wizard:
name: Harry Potter
email: h.potter@hogwarts.ac.uk
@@ -31,7 +33,7 @@ Usage
- elder wand
- resurrection stone
- invisibility cloak
- .
+ EOF
Resources