Skip to content

Commit

Permalink
Changes README and added CHANGELOG
Browse files Browse the repository at this point in the history
Signed-off-by: Ralph Niemitz <[email protected]>
  • Loading branch information
RalleYTN committed Jul 31, 2017
1 parent e227e7e commit 79df5eb
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Version 1.0.0

- Release
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ It adds type safety, serialization, tidy formatting and improved performance.
Because the original was made for Java 2. A version of Java where things like generics weren't there yet. That causes code written with the original library to be completly type unsafe.
It was a casting hell. And on top of that, you could not serialize and deserialize objects.

# Features

- [x] type safe JSON parsing
- [x] parsing JSON with a stoppable SAX like content handler
- [x] serializing and deserializing
- [x] formatting and minimizing JSON data
- [x] light weight JSON writing
- [x] a `JSONObject` and `JSONArray` class allowing for reading and writing of JSON data even without serializing

# Requirements

- Java 8 or higher
Expand Down Expand Up @@ -49,6 +58,15 @@ try {
}
```

# Setup

Just put the Java archive on your project's class path.

# Changelog

- Version 1.0.0
- Release

# List of changes made to the original library

This list only applies to version 1.0.0 of this library!
Expand All @@ -68,7 +86,6 @@ This list only applies to version 1.0.0 of this library!
- Deleted all unneeded and deprecated methods.
- Fixed a bug that would not quote non-JSON type values.


# Links
See the [original](https://github.com/fangyidong/json-simple)
See the [online documentation](https://ralleytn.github.io/SimpleJSON/)
Expand Down

0 comments on commit 79df5eb

Please sign in to comment.