Skip to content

Commit ac7e73c

Browse files
committed
[docs] Update readme
bitcoin-core/univalue is not maintained for use by other projects. Update readme to document that.
1 parent 31bc9f5 commit ac7e73c

File tree

1 file changed

+5
-16
lines changed

1 file changed

+5
-16
lines changed

README.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,10 @@ an arbitrary depth.
1212
This class is aligned with the JSON standard, [RFC
1313
7159](https://tools.ietf.org/html/rfc7159.html).
1414

15-
## Installation
15+
## Library usage
1616

17-
This project is a standard GNU
18-
[autotools](https://www.gnu.org/software/automake/manual/html_node/Autotools-Introduction.html)
19-
project. Build and install instructions are available in the `INSTALL`
20-
file provided with GNU autotools.
21-
22-
```
23-
$ ./autogen.sh
24-
$ ./configure
25-
$ make
26-
```
27-
28-
## Design
29-
30-
UniValue provides a single dynamic RAII C++ object class,
31-
and minimizes template use (contra json_spirit).
17+
This is a fork of univalue used by Bitcoin Core. It is not maintained for usage
18+
by other projects. Notably, the API may break in non-backward-compatible ways.
3219

20+
Other projects looking for a maintained library should use the upstream
21+
univalue at https://github.com/jgarzik/univalue.

0 commit comments

Comments
 (0)