Skip to content

Commit 5b9be3b

Browse files
authored
Update README.md
Add some more flair to the README.md
1 parent a072380 commit 5b9be3b

File tree

1 file changed

+32
-2
lines changed

1 file changed

+32
-2
lines changed

README.md

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,32 @@
1-
# KotlinJsonParser
2-
A Json parser written in Kotlin
1+
# KotlinJSONParser
2+
3+
KotlinJSONParser is a simple and lightweight JSON parser written in Kotlin. It allows you to easily parse JSON strings into Kotlin objects.
4+
This is mostly a toy project and with that less useful for normal usage. If you want to use a JSON parser, you should consider JSON parsers like [Jackson](https://github.com/FasterXML/jackson) or [Gson](https://github.com/google/gson).
5+
6+
## Features
7+
8+
- Lightweight and easy to use
9+
- Built with Kotlin
10+
- Simple API
11+
12+
## Getting Started
13+
14+
### Prerequisites
15+
16+
- Kotlin
17+
- Gradle
18+
19+
### Usage
20+
21+
Here's a simple example of how to use KotlinJSONParser:
22+
23+
```kotlin
24+
val jsonString = """{"name": "John", "age": 30}"""
25+
val json = jsonParse(jsonString)
26+
27+
println(json["name"]) // Output: John
28+
println(json["age"]) // Output: 30
29+
```
30+
31+
## License
32+
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)