Skip to content

Commit 4089e4d

Browse files
committed
Update documentation.
1 parent e64617e commit 4089e4d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This library is designed for correctness and simplicity, and strives for speed t
1414
It uses `std::vector` for arrays, `std::map` for objects, `std::string` for strings, `bool` for Booleans, and both `int64_t` and `double` for numbers.
1515

1616
The JSON value class contains a `union` of all of these types and does *not itself* perform any heap allocations (the wrapped `std::map`, `std::vector` and `std::string` *do* perform allocations normally).
17-
17+
1818
## Status
1919

2020
The core JSON value class is implemented and working.
@@ -32,12 +32,12 @@ The documentation will be written once all interfaces are stable...
3232
Until then, here are a few short indications on how to use this library:
3333

3434
* Requires Clang or GCC with -std=c++11 (or other compiler with sufficient C++11 support).
35-
* The library is header-only, to install and use simply copy the directory `include/tao` to a convenient place and include the file `include/tao/json.hh`.
35+
* This library is header-only, to install and use simply copy the directory `include/tao` to a convenient place and include the file `include/tao/json.hh`.
3636
* The generic JSON value class, the main part of this library, is in `include/tao/json/value.hh`.
37-
* The interface and functions of class `tao::json::value` are hopefully reasonably self-explanatory.
38-
* To parse a JSON string representation, use one of the functions in `include/tao/json/parse.hh`.
39-
* To produce a JSON string representation, use one of the appropriate functions in `include/tao/json/stream.hh`.
40-
* Operators to compare JSON value objects are provided, as are equality operators between JSON values and some other types.
37+
* The interface and functions of class `tao::json::value` are hopefully sufficiently self-explanatory.
38+
* To parse a JSON string representation, use one of the functions in `include/tao/json/from_string.hh` or `include/tao/json/parse_file.hh`.
39+
* To produce a JSON string representation, use one of the appropriate functions in `include/tao/json/to_string.hh` or `include/tao/json/stream.hh`.
40+
* Operators to compare JSON value objects are provided, as are equality operators between JSON values and some other types, in `include/tao/json/compare.hh`.
4141

4242
For questions and suggestions please contact the authors at **jsonl(at)colin-hirsch.net**.
4343

0 commit comments

Comments
 (0)