aboutsummaryrefslogtreecommitdiff
path: root/src/univalue/README.md
diff options
context:
space:
mode:
authorMarcoFalke <falke.marco@gmail.com>2017-09-29 14:31:36 +0200
committerMarcoFalke <falke.marco@gmail.com>2017-09-29 14:35:46 +0200
commitfaaeeb0d3e777d991c7cfee983bea369c109f5cc (patch)
treec55d3d58f96acbbe9a4fc4ccd5b6f3a7e638a179 /src/univalue/README.md
parentbbc901d3a683c92438a6b28dca50b956decc4433 (diff)
parent619bb05037a55c4b73973965989d199d8cb62f74 (diff)
Bump univalue and fix json formatting in tests
This merge commit bumps the univalue subtree and also updates the whitespace for some failing tests.
Diffstat (limited to 'src/univalue/README.md')
-rw-r--r--src/univalue/README.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/src/univalue/README.md b/src/univalue/README.md
new file mode 100644
index 0000000000..36aa786a4c
--- /dev/null
+++ b/src/univalue/README.md
@@ -0,0 +1,32 @@
+
+# UniValue
+
+## Summary
+
+A universal value class, with JSON encoding and decoding.
+
+UniValue is an abstract data type that may be a null, boolean, string,
+number, array container, or a key/value dictionary container, nested to
+an arbitrary depth.
+
+This class is aligned with the JSON standard, [RFC
+7159](https://tools.ietf.org/html/rfc7159.html).
+
+## Installation
+
+This project is a standard GNU
+[autotools](https://www.gnu.org/software/automake/manual/html_node/Autotools-Introduction.html)
+project. Build and install instructions are available in the `INSTALL`
+file provided with GNU autotools.
+
+```
+$ ./autogen.sh
+$ ./configure
+$ make
+```
+
+## Design
+
+UniValue provides a single dynamic RAII C++ object class,
+and minimizes template use (contra json_spirit).
+