Changeset View
Changeset View
Standalone View
Standalone View
src/univalue/README.md
# UniValue | # UniValue | ||||
## Summary | ## Summary | ||||
A universal value class, with JSON encoding and decoding. | A universal value class, with JSON encoding and decoding. | ||||
UniValue is an abstract data type that may be a null, boolean, string, | UniValue is an abstract data type that may be a null, boolean, string, | ||||
number, array container, or a key/value dictionary container, nested to | number, array container, or a key/value dictionary container, nested to | ||||
an arbitrary depth. | an arbitrary depth. | ||||
This class is aligned with the JSON standard, [RFC | This class is aligned with the JSON standard, [RFC | ||||
7159](https://tools.ietf.org/html/rfc7159.html). | 7159](https://tools.ietf.org/html/rfc7159.html). | ||||
## Motivation | |||||
UniValue is a reaction to json_spirit, seeking to minimize template | |||||
and memory use, providing a straightforward RAII class compatible with | |||||
link-time optimization and embedded uses. | |||||
## Installation | ## Installation | ||||
This project is a standard GNU | This project is a standard GNU | ||||
[autotools](https://www.gnu.org/software/automake/manual/html_node/Autotools-Introduction.html) | [autotools](https://www.gnu.org/software/automake/manual/html_node/Autotools-Introduction.html) | ||||
project. Build and install instructions are available in the `INSTALL` | project. Build and install instructions are available in the `INSTALL` | ||||
file provided with GNU autotools. | file provided with GNU autotools. | ||||
``` | ``` | ||||
$ ./autogen.sh | $ ./autogen.sh | ||||
$ ./configure | $ ./configure | ||||
$ make | $ make | ||||
``` | ``` | ||||
## Design | |||||
UniValue provides a single dynamic RAII C++ object class, | |||||
and minimizes template use (contra json_spirit). | |||||