From 8d65ac671b03238dc7e6d6c9b2b9e5fa679c5f45 Mon Sep 17 00:00:00 2001 From: Divan Visagie Date: Mon, 12 Aug 2013 21:24:37 +0200 Subject: [PATCH 1/2] Update and rename README to README.md --- README => README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) rename README => README.md (97%) mode change 100755 => 100644 diff --git a/README b/README.md old mode 100755 new mode 100644 similarity index 97% rename from README rename to README.md index b77c71a21..f1225e83c --- a/README +++ b/README.md @@ -1,4 +1,7 @@ -JSON in Java [package org.json] +JSON in Java +============ + +#### [package org.json] Douglas Crockford douglas@crockford.com From fea1c3cb76d992a17788639b1af9fcc714188674 Mon Sep 17 00:00:00 2001 From: Divan Visagie Date: Mon, 12 Aug 2013 21:32:14 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 56 +++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 36 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index f1225e83c..b4d793c28 100644 --- a/README.md +++ b/README.md @@ -20,52 +20,68 @@ This is a reference implementation. There is a large number of JSON packages in Java. Perhaps someday the Java community will standardize on one. Until then, choose carefully. -The license includes this restriction: "The software shall be used for good, -not evil." If your conscience cannot live with that, then choose a different -package. - The package compiles on Java 1.2 thru Java 1.4. -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 JSONObject can parse text from a String or a JSONTokener +#### JSONArray.java: +The JSONObject 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. -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. + +## License + +The license includes this restriction: "The software shall be used for good, +not evil." If your conscience cannot live with that, then choose a different +package.