closes #107 #127 (#129)

* closes #128

* closes #107 #127

Author: SubhenduShekhar

README.md

@@ -19,38 +19,57 @@
     </div>
 </div>
 
-
 <br/><br/><br/>
 
-## Content
+<center style="color:red">
+<p style="font-size:20px">We are restricting NPM and Python packages to 2.0.0<br/>
+Further versions will only be provided for dotnet and java</p>
+</center>
+
+<br/><br/><br/>
 
-- [Import multiple JSON files](#import-multiple-json-files)
-- [Deserializing CJSON/JSON string content](#deserializing-cjsonjson-string-content)
-- [Calling relative keys using JPATH](#calling-relative-keys-using-jpath)
-- [Dynamic variable injection](#dynamic-variable-injection)
-- [Single/ Multiple line comments](#single-multiple-line-comments)
-- [Removing key](#removing-key)
-- [Converting `Class object` to `JSON String`]()
+# Content
+
+- [CJSON format Features](#cjson-format-features)
+    - [Import CJSON/JSON files](#import-multiple-json-files)
+    - [Referencing another key](#referencing-another-key)
+    - [Dynamic variable injection](#dynamic-variable-injection)
+        - [Single injection](#single-injection)
+        - [Bulk injection](#bulk-injection)
+    - [Single/ Multiple line comments](#single-multiple-line-comments)
+- [CJSON Utility Features](#cjson-utility-features)
+    - [Deserializing CJSON/JSON string content](#deserializing-cjsonjson-string-content)
+        - [Deserialize as class object](#deserialize-as-class-object)
+        - [Deserialize as string](#deserialize-as-string)
+    - [Remove](#removing-key)
+        - [Single removal](#single-removal)
+        - [Bulk removal](#bulk-removal)
+    - [Converting `Class object` to `JSON String`](#convert-class-object-to-json-string)
+    - [Parse data](#parse-data)
+        - [Parse](#parse)
+        - [Get all possible keys](#get-all-possible-keys)
+        - [Get all possible values](#get-all-possible-values)
+    - [Validate JSON](#validate-json)
+    - [Writing JPath](#writing-jpath)
 - [Reference Examples](#examples)
 
-## Features (v2.0.0 or higher)
+<br/>
 
+# Features (v2.0.0 or higher)
+
+## CJSON format Features
 
 ### Import multiple JSON files
 
 One of the strong feature which we have introduced is importing CJson/Json files in another CJson file.
 It works in the similar way, how we import libraries in programming languages. All you need to import it using 
 `$import "path/to/target/file"` and `deserialize` the file.
 
-### Deserializing CJSON/JSON string content
-
-Parsing of CJSON string content is also possible now. You can create CJSON object with a second parameter(specific to language). For language specific details, refer below.
-
-### Calling relative keys using JPATH
+### Referencing another key
 
 Unlike XPATH for XML files, we have JPATH for JSON files. But as the drawback of plain data files, we cannot refer any variable inside a json object to another variable. This feature is useful when you have to duplicate the json key, but the value will be pulled from another variable which is already present in the json file.
 
-You can also refer to a variable which will be loaded after importing the file.  
+You can also refer to a variable which will be loaded after importing the file.
 
 ### Dynamic variable injection
 
@@ -62,23 +81,70 @@ You can inject a variable dynamically also. Instead of replacing a variable valu
 }
 ```
 Now create a `HashMap` with key as `<id>` and store relevant value in it.
-While invoking `inject` function, pass the HashMap as the second parameter. 
+While invoking `inject` function, pass the HashMap as the second parameter.
+
+Injection can be performed single or bulk. Lets look at each one below:
+
+#### Single injection
+
+Single injection can be performed by providing key and value to the `inject()`.
+
+`inject(String key, Object value)`
+
+This function returns `deserialized` class object.
+
+#### Bulk injection
+
+Bulk injection can be performed by storing the injection data in `Dictionary` or `HashMap`
+where key is the `key` where injection need to be performed and `value` is the value.
+
+`inject(HashMap<String, Object>)`
+
+This function returns `deserialized` class object.
 
 ### Single/ Multiple line comments
 
 CJSON also supports **commented lines** by adding `//` at the start of the line.
 
 **Please note, inline comments are not supported. Contributers create an issue [here](https://github.com/users/SubhenduShekhar/projects/7)**
 
+## CJSON Utility Features
+
+### Deserializing CJSON/JSON string content
+
+Parsing of CJSON string content is also possible now. You can create CJSON object with a second parameter(specific to language). For language specific details, refer below.
+
+#### Deserialize as class object
+
+`deserialize` is a function where CJSON content is compiled and converted into equivalent JSON content.
+Now, users can consume this content as a deserailized class object like any other parser works.
+
+Refer to [example](#examples) for language specific syntax.
+
+#### Deserialize as string
+
+User can consume converted JSON content to `String` content too. Every language has a function `deserializeAsString()`
+which converts compiles and converts CJSON to JSON content and returns JSON content in string format
+
 ### Removing key
 
 Any JSON key value pair can be removed by providing its JPath.
 Please Note, if you use `remove` before `deserialize` you will receive `UndeserializedCJSON` exception.
 
 This is because, unless the content is deserialized, CJSON engine has not processed the CJSON content.
 
+This function returns deserialized class object post removal.
+
 [Here](https://github.com/SubhenduShekhar/cjson/blob/main/java/Coded-Json/README.md#removing-key) are the examples
 
+#### Single removal
+
+Single removal can be performed by simply providing the JPath as parameters.
+
+#### Bulk removal
+
+Bulk removal accepts `List<String> JPaths` to perform removal.
+
 ### Convert `Class Object` to `JSON String`
 
 Any Java object can be converted to json string by using `toString()` function.
@@ -87,6 +153,36 @@ It accepts pure java object and returns JSON in string.
 
 [Here](https://github.com/SubhenduShekhar/cjson/blob/main/java/Coded-Json/README.md#removing-key) are the examples
 
+### Parse data
+
+#### Parse
+
+This function finds the value of the provided JPath as parameter. This function returns `Object` type data.
+So a type cast will be required to unlock native functions.
+
+#### Get all possible keys
+
+Returns all possible `JPaths` inside JSON.
+
+#### Get all possible values
+
+Returns all values to all possible `JPaths` inside JSON. Before executing this function, you need call for getting all possible keys function.
+
+### Validate JSON
+
+This function validates whether the provided string is JSON content or not.
+
+### Writing JPath
+
+Unline XPath in xml format, JSON has JPath format. THe difference is, instead of `//` or `/`, JPath starts with `$.`
+Below is an example:
+
+`$.path.to.variables`
+
+If any array is encountered, below is the way index is provided:
+
+`$.path.to.array[index].variable`
+
 ### Examples
 
 - [NPM](https://github.com/SubhenduShekhar/cjson/blob/main/npm/README.md)