Update the README file

Author: Skptak

README.md

@@ -1,14 +1,37 @@
 ## coreJSON Library
 
-This repository contains the coreJSON library, a parser that strictly enforces the ECMA-404 JSON standard and is suitable for low memory footprint embedded devices. The coreJSON library is distributed under the [MIT Open Source License](LICENSE).
-
-This library has gone through code quality checks including verification that no function has a [GNU Complexity](https://www.gnu.org/software/complexity/manual/complexity.html) score over 8, and checks against deviations from mandatory rules in the [MISRA coding standard](https://www.misra.org.uk). Deviations from the MISRA C:2012 guidelines are documented under [MISRA Deviations](MISRA.md). This library has also undergone both static code analysis from [Coverity static analysis](https://scan.coverity.com/), and validation of memory safety through the [CBMC automated reasoning tool](https://www.cprover.org/cbmc/).
-
-See memory requirements for this library [here](./docs/doxygen/include/size_table.md).
-
-**coreJSON v3.2.0 [source code](https://github.com/FreeRTOS/coreJSON/tree/v3.2.0/source) is part of the [FreeRTOS 202210.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS) release.**
-
-**coreJSON v3.0.0 [source code](https://github.com/FreeRTOS/coreJSON/tree/v3.0.0/source) is part of the [FreeRTOS 202012.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.00-LTS) release.**
+**[API Documentation Pages for current and previous releases of this library can be found here](https://freertos.github.io/coreJSON/)**
+
+This repository contains the coreJSON library, a parser that strictly enforces
+the ECMA-404 JSON standard and is suitable for low memory footprint embedded
+devices. The coreJSON library is distributed under the
+[MIT Open Source License](LICENSE).
+
+This library has gone through code quality checks including verification that no
+function has a
+[GNU Complexity](https://www.gnu.org/software/complexity/manual/complexity.html)
+score over 8, and checks against deviations from mandatory rules in the
+[MISRA coding standard](https://www.misra.org.uk). Deviations from the MISRA
+C:2012 guidelines are documented under [MISRA Deviations](MISRA.md). This
+library has also undergone both static code analysis from
+[Coverity static analysis](https://scan.coverity.com/), and validation of memory
+safety through the
+[CBMC automated reasoning tool](https://www.cprover.org/cbmc/).
+
+See memory requirements for this library
+[here](./docs/doxygen/include/size_table.md).
+
+**coreJSON v3.2.0
+[source code](https://github.com/FreeRTOS/coreJSON/tree/v3.2.0/source) is part
+of the
+[FreeRTOS 202210.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202210.00-LTS)
+release.**
+
+**coreJSON v3.0.0
+[source code](https://github.com/FreeRTOS/coreJSON/tree/v3.0.0/source) is part
+of the
+[FreeRTOS 202012.00 LTS](https://github.com/FreeRTOS/FreeRTOS-LTS/tree/202012.00-LTS)
+release.**
 
 ## Reference example
 
@@ -51,41 +74,58 @@ int main()
     return 0;
 }
 ```
-A search may descend through nested objects when the `queryKey` contains matching key strings joined by a separator, `.`. In the example above, `bar` has the value `{"foo":"xyz"}`. Therefore, a search for query key `bar.foo` would output `xyz`.
+
+A search may descend through nested objects when the `queryKey` contains
+matching key strings joined by a separator, `.`. In the example above, `bar` has
+the value `{"foo":"xyz"}`. Therefore, a search for query key `bar.foo` would
+output `xyz`.
 
 ## Building coreJSON
 
-A compiler that supports **C90 or later** such as *gcc* is required to build the library.
+A compiler that supports **C90 or later** such as _gcc_ is required to build the
+library.
 
-Additionally, the library uses 2 header files introduced in ISO C99, `stdbool.h` and `stdint.h`. For compilers that do not provide this header file, the [source/include](source/include) directory contains [stdbool.readme](source/include/stdbool.readme) and [stdint.readme](source/include/stdint.readme), which can be renamed to `stdbool.h` and `stdint.h` respectively.
+Additionally, the library uses 2 header files introduced in ISO C99, `stdbool.h`
+and `stdint.h`. For compilers that do not provide this header file, the
+[source/include](source/include) directory contains
+[stdbool.readme](source/include/stdbool.readme) and
+[stdint.readme](source/include/stdint.readme), which can be renamed to
+`stdbool.h` and `stdint.h` respectively.
+
+For instance, if the example above is copied to a file named `example.c`, _gcc_
+can be used like so:
 
-For instance, if the example above is copied to a file named `example.c`, *gcc* can be used like so:
 ```bash
 gcc -I source/include example.c source/core_json.c -o example
 ./example
 ```
 
-*gcc* can also produce an output file to be linked:
+_gcc_ can also produce an output file to be linked:
+
 ```bash
 gcc -I source/include -c source/core_json.c
 ```
 
 ## Documentation
 
 ### Existing documentation
-For pre-generated documentation, please see the documentation linked in the locations below:
 
-| Location |
-| :-: |
+For pre-generated documentation, please see the documentation linked in the
+locations below:
+
+|                                                       Location                                                       |
+| :------------------------------------------------------------------------------------------------------------------: |
 | [AWS IoT Device SDK for Embedded C](https://github.com/aws/aws-iot-device-sdk-embedded-C#releases-and-documentation) |
-| [FreeRTOS.org](https://freertos.org/Documentation/api-ref/coreJSON/docs/doxygen/output/html/index.html) |
+|       [FreeRTOS.org](https://freertos.org/Documentation/api-ref/coreJSON/docs/doxygen/output/html/index.html)        |
 
-Note that the latest included version of the coreJSON library may differ across repositories.
+Note that the latest included version of the coreJSON library may differ across
+repositories.
 
 ### Generating documentation
 
 The Doxygen references were created using Doxygen version 1.9.2. To generate the
-Doxygen pages, please run the following command from the root of this repository:
+Doxygen pages, please run the following command from the root of this
+repository:
 
 ```shell
 doxygen docs/doxygen/config.doxyfile
@@ -94,28 +134,37 @@ doxygen docs/doxygen/config.doxyfile
 ## Building unit tests
 
 ### Checkout Unity Submodule
-By default, the submodules in this repository are configured with `update=none` in [.gitmodules](.gitmodules), to avoid increasing clone time and disk space usage of other repositories (like [amazon-freertos](https://github.com/aws/amazon-freertos) that submodules this repository).
 
-To build unit tests, the submodule dependency of Unity is required. Use the following command to clone the submodule:
+By default, the submodules in this repository are configured with `update=none`
+in [.gitmodules](.gitmodules), to avoid increasing clone time and disk space
+usage of other repositories (like
+[amazon-freertos](https://github.com/aws/amazon-freertos) that submodules this
+repository).
+
+To build unit tests, the submodule dependency of Unity is required. Use the
+following command to clone the submodule:
+
 ```
 git submodule update --checkout --init --recursive test/unit-test/Unity
 ```
 
 ### Platform Prerequisites
 
 - For running unit tests
-    - C90 compiler like gcc
-    - CMake 3.13.0 or later
-    - Ruby 2.0.0 or later is additionally required for the Unity test framework (that we use).
+  - C90 compiler like gcc
+  - CMake 3.13.0 or later
+  - Ruby 2.0.0 or later is additionally required for the Unity test framework
+    (that we use).
 - For running the coverage target, gcov is additionally required.
 
 ### Steps to build Unit Tests
 
-1. Go to the root directory of this repository. (Make sure that the **Unity** submodule is cloned as described [above](#checkout-unity-submodule).)
+1. Go to the root directory of this repository. (Make sure that the **Unity**
+   submodule is cloned as described [above](#checkout-unity-submodule).)
 
 1. Create build directory: `mkdir build && cd build`
 
-1. Run *cmake* while inside build directory: `cmake -S ../test`
+1. Run _cmake_ while inside build directory: `cmake -S ../test`
 
 1. Run this command to build the library and unit tests: `make all`
 
@@ -125,12 +174,16 @@ git submodule update --checkout --init --recursive test/unit-test/Unity
 
 ## CBMC
 
-To learn more about CBMC and proofs specifically, review the training material [here](https://model-checking.github.io/cbmc-training).
+To learn more about CBMC and proofs specifically, review the training material
+[here](https://model-checking.github.io/cbmc-training).
 
 The `test/cbmc/proofs` directory contains CBMC proofs.
 
-In order to run these proofs you will need to install CBMC and other tools by following the instructions [here](https://model-checking.github.io/cbmc-training/installation.html).
+In order to run these proofs you will need to install CBMC and other tools by
+following the instructions
+[here](https://model-checking.github.io/cbmc-training/installation.html).
 
 ## Contributing
 
-See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on contributing.
+See [CONTRIBUTING.md](./.github/CONTRIBUTING.md) for information on
+contributing.