diff --git a/README.md b/README.md index 73083d5..6dfd22a 100644 --- a/README.md +++ b/README.md @@ -21,52 +21,52 @@ package. The package compiles on Java 1.6-1.8. -`JSONObject.java`: The `JSONObject` can parse text from a `String` or a `JSONTokener` +**JSONObject.java**: The `JSONObject` can parse text from a `String` or a `JSONTokener` to produce a map-like object. The object provides methods for manipulating its contents, and for producing a JSON compliant object serialization. -`JSONArray.java`: The `JSONArray` can parse text from a String or a `JSONTokener` +**JSONArray.java**: The `JSONArray` can parse text from a String or a `JSONTokener` to produce a vector-like object. The object provides methods for manipulating its contents, and for producing a JSON compliant array serialization. -`JSONTokener.java`: The `JSONTokener` breaks a text into a sequence of individual +**JSONTokener.java**: The `JSONTokener` breaks a text into a sequence of individual tokens. It can be constructed from a `String`, `Reader`, or `InputStream`. -`JSONException.java`: The `JSONException` is the standard exception type thrown +**JSONException.java**: The `JSONException` is the standard exception type thrown by this package. -`JSONPointer.java`: Implementation of +**JSONPointer.java**: Implementation of [JSON Pointer (RFC 6901)](https://tools.ietf.org/html/rfc6901). Supports JSON Pointers both in the form of string representation and URI fragment representation. -`JSONString.java`: The `JSONString` interface requires a `toJSONString` method, +**JSONString.java**: The `JSONString` interface requires a `toJSONString` method, allowing an object to provide its own serialization. -`JSONStringer.java`: The `JSONStringer` provides a convenient facility for +**JSONStringer.java**: The `JSONStringer` provides a convenient facility for building JSON strings. -`JSONWriter.java`: The `JSONWriter` provides a convenient facility for building +**JSONWriter.java**: The `JSONWriter` provides a convenient facility for building JSON text through a writer. -`CDL.java`: `CDL` provides support for converting between JSON and comma +**CDL.java**: `CDL` provides support for converting between JSON and comma delimited lists. -`Cookie.java`: `Cookie` provides support for converting between JSON and cookies. +**Cookie.java**: `Cookie` provides support for converting between JSON and cookies. -`CookieList.java`: `CookieList` provides support for converting between JSON and +**CookieList.java**: `CookieList` provides support for converting between JSON and cookie lists. -`HTTP.java`: `HTTP` provides support for converting between JSON and HTTP headers. +**HTTP.java**: `HTTP` provides support for converting between JSON and HTTP headers. -`HTTPTokener.java`: `HTTPTokener` extends `JSONTokener` for parsing HTTP headers. +**HTTPTokener.java**: `HTTPTokener` extends `JSONTokener` for parsing HTTP headers. -`XML.java`: `XML` provides support for converting between JSON and XML. +**XML.java**: `XML` provides support for converting between JSON and XML. -`JSONML.java`: `JSONML` provides support for converting between JSONML and XML. +**JSONML.java**: `JSONML` provides support for converting between JSONML and XML. -`XMLTokener.java`: `XMLTokener` extends JSONTokener for parsing XML text. +**XMLTokener.java**: `XMLTokener` extends JSONTokener for parsing XML text. Unit tests are maintained in a separate project. Contributing developers can test JSON-java pull requests with the code in this project: