Skip to content

Commit 18efda8

Browse files
committed
update README
1 parent f6c5cc4 commit 18efda8

File tree

1 file changed

+48
-1
lines changed

1 file changed

+48
-1
lines changed

README.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,48 @@
1-
# json
1+
# JSON
2+
3+
Simple JSON library for modern C++ with no dependencies. A few features include:
4+
5+
- 📜 Parsing JSON from a string or file
6+
- 📝 Writing JSON to a string or file
7+
- 🔑 Accessing JSON values by key or index
8+
- 🔄 Iterating over JSON objects and arrays
9+
- ✏️ Modifying JSON objects and arrays
10+
- 🎨 Pretty printing JSON
11+
- All with a simple and intuitive API 😊
12+
13+
## Usage 💻
14+
15+
0. Make sure you have the gnu g++ compiler installed on your system. You can install it by running the following command:
16+
17+
```bash
18+
sudo apt install g++ build-essential
19+
```
20+
21+
1. Clone the repository:
22+
23+
```bash
24+
git clone --recurse-submodules git@github.com:coding-cpp/json.git
25+
```
26+
27+
2. Build the project 🔨
28+
29+
```bash
30+
cd json
31+
mkdir build && cd build
32+
cmake ..
33+
make
34+
```
35+
36+
![Building](./assets/build.png)
37+
38+
3. Run the example
39+
40+
```bash
41+
./json
42+
```
43+
44+
![Running](./assets/output.png)
45+
46+
## Example 🛠️
47+
48+
You can find an example of how to use the library in the [`example`](./example/) directory.

0 commit comments

Comments
 (0)