From b7e2eee4d692a0fd9b8c98ed66a67fc5fbbdd3ab Mon Sep 17 00:00:00 2001 From: Felix Leipold Date: Tue, 14 Nov 2017 16:52:03 +0100 Subject: [PATCH 1/9] Renaming README to README.md --- README => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename README => README.md (100%) diff --git a/README b/README.md similarity index 100% rename from README rename to README.md From 26160e1619326410e15e1bb6dc792546ddac4ec2 Mon Sep 17 00:00:00 2001 From: Felix Leipold Date: Tue, 14 Nov 2017 17:01:22 +0100 Subject: [PATCH 2/9] Remove trailing whitespace --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 9783046..3e0c9d9 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ tokens. It can be constructed from a String, Reader, or InputStream. 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. @@ -65,16 +65,16 @@ JSONML.java: JSONML provides support for converting between JSONML and XML. 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: +Unit tests are maintained in a separate project. Contributing developers can test +JSON-java pull requests with the code in this project: https://github.com/stleary/JSON-Java-unit-test -Numeric types in this package comply with ECMA-404: The JSON Data Interchange Format -(http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf) and -RFC 7159: The JavaScript Object Notation (JSON) Data Interchange Format -(https://tools.ietf.org/html/rfc7159#section-6). -This package fully supports Integer, Long, and Double Java types. Partial support -for BigInteger and BigDecimal values in JSONObject and JSONArray objects is provided +Numeric types in this package comply with ECMA-404: The JSON Data Interchange Format +(http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf) and +RFC 7159: The JavaScript Object Notation (JSON) Data Interchange Format +(https://tools.ietf.org/html/rfc7159#section-6). +This package fully supports Integer, Long, and Double Java types. Partial support +for BigInteger and BigDecimal values in JSONObject and JSONArray objects is provided in the form of get(), opt(), and put() API methods. Although 1.6 compatibility is currently supported, it is not a project goal and may be @@ -95,10 +95,10 @@ Release history: 20160810 Revert code that was breaking opt*() methods. -20160807 This release contains a bug in the JSONObject.opt*() and JSONArray.opt*() methods, +20160807 This release contains a bug in the JSONObject.opt*() and JSONArray.opt*() methods, it is not recommended for use. Java 1.6 compatability fixed, JSONArray.toList() and JSONObject.toMap(), -RFC4180 compatibility, JSONPointer, some exception fixes, optional XML type conversion. +RFC4180 compatibility, JSONPointer, some exception fixes, optional XML type conversion. Contains the latest code as of 7 Aug, 2016 20160212 Java 1.6 compatibility, OSGi bundle. Contains the latest code as of 12 Feb, 2016. @@ -106,9 +106,9 @@ Contains the latest code as of 7 Aug, 2016 20151123 JSONObject and JSONArray initialization with generics. Contains the latest code as of 23 Nov, 2015. -20150729 Checkpoint for Maven central repository release. Contains the latest code -as of 29 July, 2015. +20150729 Checkpoint for Maven central repository release. Contains the latest code +as of 29 July, 2015. -JSON-java releases can be found by searching the Maven repository for groupId "org.json" -and artifactId "json". For example: +JSON-java releases can be found by searching the Maven repository for groupId "org.json" +and artifactId "json". For example: https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22org.json%22%20AND%20a%3A%22json%22 From dba4afd0cfd88408215f7b8a0725d104ef450337 Mon Sep 17 00:00:00 2001 From: Felix Leipold Date: Tue, 14 Nov 2017 16:51:14 +0100 Subject: [PATCH 3/9] Adding maven repo badge --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 3e0c9d9..97f9379 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![Maven Central](https://img.shields.io/maven-central/v/org.json/json.svg)](https://mvnrepository.com/artifact/org.json/json) + JSON in Java [package org.json] JSON is a light-weight, language independent, data interchange format. From b3068d9fe411978ad6dffe6fc47ec0194513e879 Mon Sep 17 00:00:00 2001 From: Felix Leipold Date: Tue, 14 Nov 2017 17:05:27 +0100 Subject: [PATCH 4/9] Marking file and class names with single quotes --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 97f9379..3c0d7f2 100644 --- a/README.md +++ b/README.md @@ -20,52 +20,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 -tokens. It can be constructed from a String, Reader, or InputStream. +`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: From c88653ca2e4fe70d550b42781232fced3f0e2397 Mon Sep 17 00:00:00 2001 From: Felix Leipold Date: Tue, 14 Nov 2017 17:16:51 +0100 Subject: [PATCH 5/9] History with fixed font --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 3c0d7f2..7857df8 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,8 @@ invalid number formats (1.2e6.3) will cause errors as such documents can not be reliably. Release history: + +~~~ 20171018 Checkpoint for recent commits. 20170516 Roll up recent commits. @@ -110,6 +112,8 @@ latest code as of 23 Nov, 2015. 20150729 Checkpoint for Maven central repository release. Contains the latest code as of 29 July, 2015. +~~~ + JSON-java releases can be found by searching the Maven repository for groupId "org.json" and artifactId "json". For example: From 28efdb4860672faa3154db52cb6aa4669dbb0a1c Mon Sep 17 00:00:00 2001 From: Felix Leipold Date: Fri, 17 Nov 2017 12:24:03 +0100 Subject: [PATCH 6/9] Moving Badge below title --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7857df8..73083d5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -[![Maven Central](https://img.shields.io/maven-central/v/org.json/json.svg)](https://mvnrepository.com/artifact/org.json/json) - JSON in Java [package org.json] +=============================== + +[![Maven Central](https://img.shields.io/maven-central/v/org.json/json.svg)](https://mvnrepository.com/artifact/org.json/json) JSON is a light-weight, language independent, data interchange format. See http://www.JSON.org/ From 195963357c4d79c40a14443af8a48edab03626d0 Mon Sep 17 00:00:00 2001 From: Felix Leipold Date: Fri, 17 Nov 2017 12:24:17 +0100 Subject: [PATCH 7/9] Make file names bold --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) 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: From 9eb8c27724a669841f7a6ab38f7916bf8d4c691d Mon Sep 17 00:00:00 2001 From: Felix Leipold Date: Fri, 17 Nov 2017 12:33:50 +0100 Subject: [PATCH 8/9] Marking up class and method names as inline code --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6dfd22a..dcbdef5 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ cookie lists. **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: @@ -76,9 +76,9 @@ Numeric types in this package comply with ECMA-404: The JSON Data Interchange Fo (http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf) and RFC 7159: The JavaScript Object Notation (JSON) Data Interchange Format (https://tools.ietf.org/html/rfc7159#section-6). -This package fully supports Integer, Long, and Double Java types. Partial support -for BigInteger and BigDecimal values in JSONObject and JSONArray objects is provided -in the form of get(), opt(), and put() API methods. +This package fully supports `Integer`, `Long`, and `Double` Java types. Partial support +for `BigInteger` and `BigDecimal` values in `JSONObject` and `JSONArray` objects is provided +in the form of `get()`, `opt()`, and `put()` API methods. Although 1.6 compatibility is currently supported, it is not a project goal and may be removed in some future release. From b6efbabc3202feefbd8cd66a307d247f66496c3b Mon Sep 17 00:00:00 2001 From: Felix Leipold Date: Fri, 17 Nov 2017 12:46:01 +0100 Subject: [PATCH 9/9] Making links markdown links --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dcbdef5..54abcb0 100644 --- a/README.md +++ b/README.md @@ -72,10 +72,9 @@ Unit tests are maintained in a separate project. Contributing developers can tes JSON-java pull requests with the code in this project: https://github.com/stleary/JSON-Java-unit-test -Numeric types in this package comply with ECMA-404: The JSON Data Interchange Format -(http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf) and -RFC 7159: The JavaScript Object Notation (JSON) Data Interchange Format -(https://tools.ietf.org/html/rfc7159#section-6). +Numeric types in this package comply with +[ECMA-404: The JSON Data Interchange Format](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf) and +[RFC 7159: The JavaScript Object Notation (JSON) Data Interchange Format](https://tools.ietf.org/html/rfc7159#section-6). This package fully supports `Integer`, `Long`, and `Double` Java types. Partial support for `BigInteger` and `BigDecimal` values in `JSONObject` and `JSONArray` objects is provided in the form of `get()`, `opt()`, and `put()` API methods.