Convert README to markdown style.

sipa · May 3, 2017 · f1b86ed · f1b86ed
1 parent 1dfe464
commit f1b86ed
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 7 deletions.
diff --git a/README b/README
diff --git a/README.md b/README.md
@@ -0,0 +1,30 @@
+
+# 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 following the `autogen.sh` step.
+
+```$ ./autogen.sh
+$ ./configure
+$ make
+
+## Design
+
+UniValue provides a single dynamic RAII C++ object class,
+and minimizes template use (contra json_spirit).
+