updated readme file and added new files in documentation folder

Author: arpitkuriyal

.gitignore

@@ -1,7 +1,7 @@
 node_modules/
 
-
 /docs
+
 scratch/
 TODO*
 .DS_Store

README.md

@@ -35,8 +35,6 @@ This module is designed for node.js (ES Modules, TypeScript) and browsers. It
 should work in Bun and Deno as well, but the test runner doesn't work in these
 environments, so this module may be less stable in those environments.
 
-
-
 ## Examples and Basic Usage
 Better JSON Schema Errors works with **any JSON Schema validator** that follows the official [JSON Schema Output Format](https://json-schema.org/draft/2020-12/json-schema-core#name-output-structure).  
 In this example, we’ll showcase it with the [Hyperjump JSON Schema Validator](https://github.com/hyperjump-io/json-schema).  
@@ -116,36 +114,36 @@ We need contributions from different countries to add more languages.
 
 To change the language, pass a language option to the betterJsonSchemaErrors function, like this:  
 
-```
+```js
 const friendlyErrors = await betterJsonSchemaErrors(result, schemaUri, instance, { language: "en-US" });
 ```
 
-### 4. Handling `anyOf` with Clarity
+### 4. Handling `anyOf`/`oneOf` with Clarity
 
-The `anyOf` keyword is a powerful but complex JSON Schema feature. **Better-JSON-Schema-Errors** intelligently simplifies its output by providing clear, consolidated error messages that are easier to debug. 
+The `anyOf`/`oneOf` keyword is a powerful but complex JSON Schema feature. **better-json-schema-errors** intelligently simplifies its output by providing clear, consolidated error messages that are easier to debug. Whenever possible it will try to determine which alternative the user intended and focus the error output to only those errors related to correcting the data for that alternative.
 
 **Schema:**
 ```json
 {
   "anyOf": [
-    { "type": "string" },
+    { "type": "string", "minLength": 5 },
     { "type": "number" }
   ]
 }
 ```
 
 Invalid Instance:-
-``` Json
-false
+```json
+"abc"
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errors": [
     {
-      "schemaLocation": "https://example.com/main#/anyOf",
+      "schemaLocation": "https://example.com/main#/anyOf/0/minLength",
       "instanceLocation": "#",
-      "message": "The instance should be of type 'string' or 'number' but found 'boolean'."
+      "message": "Expected a string at least 5 characters long."
     }
   ]
 }
@@ -174,7 +172,7 @@ Example:
 This makes typos or near-misses much easier to debug.
 For full details and strategies, see the dedicated [enum documentation](./documentation/enum.md).
 
-### 6. Range constraint keyword
+### 6. Range constraint keywords
 Better JSON Schema Errors consolidates multiple range-related validation errors (`minimum`, `maxLength`, `minItems`, etc.) into a single, clear message.  
 For example, a schema like:
 ```json
@@ -185,11 +183,11 @@ For example, a schema like:
 }
 ```
 Instance:-
-```Json
+```json
 2
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errors": [
     {
@@ -200,17 +198,20 @@ BetterJSONSchemaErrors Output:-
   ]
 }
 ```
-Instead of 2 error message it manage to give single concise error message. For details, see the dedicated [Range documenetation](./documentation/range-handler.md)
+Instead of 2 error message it manages to give a single concise error message. For details, see the dedicated [Range documenetation](./documentation/range-handler.md)
 
 ### 6. Custom Keywords and Error Handlers
-In order to create the custom keywords and error handlers we need create and register two types of handler: **Normalization Handler** and **Error Handlers**
+In order to create the custom keywords and error handlers we need to create and
+register two types of handlers: **Normalization Handler** and **Error Handlers**.
 
-1. Normalization: This phase takes the raw, often deeply nested, error tree from the validator and converts it into a NormalizedOutput (can check type of normalizedOutput in the index.d.ts file).  
+1. Normalization: This phase takes the raw, often deeply nested, error output
+from the validator and converts it into a NormalizedOutput (you can check type of
+normalizedOutput in the index.d.ts file).
 
-2. Error Handling: This phase takes the normalized data and uses it to generate the final error messages. This is the job of the Error Handlers.  
+2. Error Handling: This phase takes the normalized output and uses it to generate the final error messages. This is the job of the Error Handlers.  
 
 Fist step -: Creating the keywordHandler
-```Js
+```js
 /**
  * @import { KeywordHandler } from "@hyperjump/better-json-schema-errors"
  */
@@ -227,7 +228,7 @@ export default multipleOfTen;
 ```
 
 Second step -: Creating the errorHandler
-```Js
+```js
 import { getSchema } from "@hyperjump/json-schema/experimental";
 import * as Schema from "@hyperjump/browser";
 import * as Instance from "@hyperjump/json-schema/instance/experimental";
@@ -261,11 +262,11 @@ const ErrorHandler = async (normalizedErrors, instance, localization) => {
 
 Step 3:- Register the handlers:
 
-```Js
+```js
 import { setNormalizationHandler, addErrorHandler  } from "@hyperjump/better-json-schema-errors";
-const KEYWORD_URI = "https://example.com/keyword/multipleOfTen";
+const KEYWORD_URI = "https://json-schema.org/keyword/multipleOfTen";
 
-setNormalizationHandler(CUSTOM_KEYWORD_URI, multipleOften);
+setNormalizationHandler(KEYWORD_URI, multipleOften);
 
 addErrorHandler(errorHandler);
 ```

documentation/anyOf.md

@@ -1,6 +1,6 @@
 ##  Handling `anyOf` with Clarity
 
-**Better JSON Schema Errors** intelligently simplifies error output, providing clear, consolidated error messages that are easier to debug.
+`better-json-schema-errors` intelligently simplifies error output, providing clear, consolidated error messages that are easier to debug.
 Here are the differnt cases and how better-json-schema-errors handles them to produces better errors.
 
 ---
@@ -20,11 +20,11 @@ If the instance's type doesn't match any of the alternatives in an `anyOf`, the
 ```
 
 Invalid Instance:-
-``` Json
+```json
 false
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errors": [
     {
@@ -51,11 +51,11 @@ If the instance's type matches one of the `anyOf` alternatives but fails a subse
 ```
 
 Invalid Instance:-
-``` Json
+```json
 "abc"
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errors": [
     {
@@ -98,15 +98,15 @@ When an instance matches multiple `anyOf` alternatives type, the library priorit
 ```
 
 Invalid Instance:-
-``` Json
+```json
 {
   "title": "Clean Code",
   "author": "Robert Martin",
   "ID": "NotValidId"
 }
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errors": [
     {
@@ -133,11 +133,11 @@ When an instance fails all enum or const options in an anyOf, the library merges
 ```
 
 Invalid Instance:-
-``` Json
+```json
 2
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errors": [
     {
@@ -159,21 +159,31 @@ When `anyOf` uses a discriminator, the library leverages it to give precise erro
 ```json
 {
   "anyOf": [
-    { "properties": { "type": { "const": "a" }, "apple": { "type": "string" } } },
-    { "properties": { "type": { "const": "b" }, "banana": { "type": "string" } } }
+    { 
+      "properties": { 
+      "type": { "const": "a" }, 
+      "apple": { "type": "string" } 
+      } 
+    },
+    {
+      "properties": {
+        "type": { "const": "b" },
+        "banana": { "type": "string" }
+      }
+    }
   ]
 }
 ```
 
 Invalid Instance:-
-``` Json
+```json
 {
   "type": "a",
   "apple": 42
 }
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errors": [
     {
@@ -183,5 +193,4 @@ BetterJSONSchemaErrors Output:-
     }
   ]
 }
-
 ```

documentation/enum.md

@@ -14,17 +14,16 @@ Example Schema:
 **Schema:**
 ```json
 {
-  "type": "string",
   "enum": ["apple", "banana", "orange"]
 }
 ```
 
 Invalid Instance:-
-``` Json
+```json
 { "fruit": "appl" }
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errros": {
     "message": "Unexpected value 'appl'. Did you mean 'apple'?",
@@ -41,17 +40,16 @@ Example Schema:
 **Schema:**
 ```json
 {
-  "type": "string",
   "enum": ["apple", "banana", "orange"]
 }
 ```
 
 Invalid Instance:-
-``` Json
+```json
 { "fruit": "grape" }
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errros": {
     "message": "Unexpected value 'grape'. Expected one of: 'apple', 'banana', or 'orange'.",

documentation/range-handler.md

@@ -1,6 +1,6 @@
 # Range Constraint Keywords
 
-better-json-schema-errros processes validation errors for keywords that define a numeric range or count, such as `minimum`/`maximum`/`exclusiveMinimum`/`exculsiveMaximum` for numbers, `minLength`/`maxLength` for strings, `minItems`/`maxItems` for arrays, and `minProperties`/`maxProperties` for objects.  
+`better-json-schema-errors` processes validation errors for keywords that define a numeric range or count, such as `minimum`/`maximum`/`exclusiveMinimum`/`exculsiveMaximum` for numbers, `minLength`/`maxLength` for strings, `minItems`/`maxItems` for arrays, and `minProperties`/`maxProperties` for objects.  
 The primary goal is to consolidate multiple, separate validation errors related to these constraints into a single, clear, and human-readable message that describes the effective valid range for the instance.
 
 ---
@@ -26,7 +26,7 @@ This handler improves the user experience by implementing a unified consolidatio
 ### Examples
 ### 1. **Number** (`minimum`, `maximum`, `exclusiveMinimum`, `exclusiveMaximum`)
 Schema:
-```Json
+```json
 {
   "allOf": [
     { "minimum": 3 },
@@ -35,11 +35,11 @@ Schema:
 }
 ```
 Instance:-
-```Json
+```json
 2
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errors": [
     {
@@ -54,7 +54,7 @@ BetterJSONSchemaErrors Output:-
 
 ### 2. **String** (`minLength`, `maxLength`)
 Schema:
-```Json
+```json
 {
   "allOf": [
     { "minLength": 3 },
@@ -63,11 +63,11 @@ Schema:
 }
 ```
 Instance:-
-```Json
+```json
 "helo"
 ```
-BetterJSONSchemaErrors Output:-
-``` Json
+`better-json-schema-errors` Output:-
+```json
 {
   "errors": [
     {
@@ -82,7 +82,7 @@ BetterJSONSchemaErrors Output:-
 
 ### 3. **Array** (`minItems`, `maxItems`)
 Schema:
-```Json
+```json
 {
   "allOf": [
     { "minItems": 3 },
@@ -91,11 +91,11 @@ Schema:
 }
 ```
 Instance:-
-```Json
+```json
 [1,2]
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errors": [
     {
@@ -112,7 +112,7 @@ BetterJSONSchemaErrors Output:-
 ```
 ### 4. **Object** (`minProperties`, `maxProperties`)
 Schema:
-```Json
+```json
 {
   "allOf": [
     { "minProperties": 2 },
@@ -121,11 +121,11 @@ Schema:
 }
 ```
 Instance:-
-```Json
+```json
 {"a": 1}
 ```
 BetterJSONSchemaErrors Output:-
-``` Json
+```json
 {
   "errors": [
     {