publish: v1.3.1

* enhance: readme.md documentation

* change: version number from 1.3.0 to 1.3.1

Author: woigl

README.md

@@ -13,6 +13,7 @@ $ npm install rsql-query-builder
 ```
 
 ## Using the RSQL Builder
+
 ```typescript
 /* Long Version */
 const builder = new RSQLBuilder().equal('name', 'Filip').and().greaterThan('age', 30);
@@ -25,10 +26,55 @@ console.log(new RSQLBuilder().equal('name', 'Filip').and().greaterThan('age', 30
 // Output: name=="Filip";age=gt=30
 ```
 
-## Extending the RSQL Builder
+## RSQL Builder Methods
+
+The `RSQLBuilder` class provides many methods to build the desired RSQL string.
+
+### Initialization
+
+constructor()
+
+### Comparisons Operators (Defining Conditions)
+
+`equal(selector, value)` - Appends a condition `selector == value`.
+`notEqual(selector, value)` - Appends a condition `selector != value`.
+`lessThan(selector, value)` - Appends a condition `selector =lt= value`.
+`lessThanOrEqual(selector, value)` - Appends a condition `selector =le= value`.
+`greaterThan(selector, value)` - Appends a condition `selector =gr= value`.
+`greaterThanOrEqual(selector, value)` - Appends a condition `selector =ge= value`.
+`in(selector, values)` - Appends a condition `selector =in= (values)`.
+`notIn(selector, value)` - Appends a condition `selector =out= (values)`.
+
+### Expression Grouping (Organizing Conditions)
+
+`group(builder)` - Wraps the conditions from another RSQLBuilder instance in parentheses for grouping.
+
+### Logical Operators (Combining Conditions)
+
+`and()` – Appends the logical **AND** operator `;`.
+`or()` - Appends a logical **OR** operator `,`.
+
+### RSQL Builder Composition (Combining Multiple RSQL Queries)
+
+`concat(builder)` – Appends all expressions from another RSQLBuilder instance to the current instance.
+`merge(builders)` – Merges multiple RSQLBuilder instances into grouped conditions.
+
+### RSQL String Management (Finalizing the Query)
+
+`toString()` - Returns the generated RSQL query string.
+`isEmpty()` – Returns true if the RSQLBuilder instance has no expressions; otherwise, returns false.
+`reset()` – Clears all expressions, resetting the RSQLBuilder instance.
+
+### Static Utilities
+
+`merge(builders)` – Creates a new RSQLBuilder instance and merges multiple RSQLBuilder instances into grouped conditions.
+
+## Extending the RSQL Query Builder
+
 You can extend the RSQL Builder to customize it for your needs.
 
 This is a sample extension:
+
 ```typescript
 import RSQLBuilderBase, { RSQLBuilderOptions } from './RSQLBuilderBase';
 
@@ -52,21 +98,21 @@ class RSQLBuilderSample<TSelector extends string = string> extends RSQLBuilderBa
     }
 
     /** Add a like comparison to the query.
-     * 
+     *
      * @param selector - The field name
      * @param value - The value to compare
-     * 
+     *
      * @returns The builder instance
      */
     like(selector: TSelector, value: string | number | Date | null): this {
         return this.addComparison(selector, 'like', value);
     }
 
     /** Add a not like comparison to the query.
-     * 
+     *
      * @param selector - The field name
      * @param value - The value to compare
-     * 
+     *
      * @returns The builder instance
      */
     notLike(selector: TSelector, value: string | number | Date | null): this {
@@ -89,4 +135,4 @@ export default RSQLBuilderSample;
 [npm-url]: https://npmjs.org/package/rsql-query-builder
 [npm-license-image]: https://img.shields.io/npm/l/rsql-query-builder
 [coveralls-image]: https://coveralls.io/repos/github/woigl/rsql-query-builder/badge.svg?branch=main
-[coveralls-url]: https://coveralls.io/github/woigl/rsql-query-builder?branch=main
+[coveralls-url]: https://coveralls.io/github/woigl/rsql-query-builder?branch=main

package.json

@@ -1,6 +1,6 @@
 {
     "name": "rsql-query-builder",
-    "version": "1.3.0",
+    "version": "1.3.1",
     "description": "Library for building RSQL query strings.",
     "main": "dist/index.js",
     "module": "dist/index.mjs",