Updated docs

janis-commerce · Sep 27, 2019 · 1c7e4d0 · 1c7e4d0
1 parent ca0964e
commit 1c7e4d0
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+### Added
+- `multiRemove` wrapper for `remove` method
+
 ## [1.4.0] - 2019-09-12
 ### Added
 - `MySQLConfigError`

diff --git a/README.md b/README.md
@@ -103,6 +103,14 @@ const config = {
         - `joins`: Learn [More](https://github.com/janis-commerce/query-builder/blob/master/docs/Joins.md).
     - **Returns**, `number` of the quantity of rows were removed correctly.
 
+* `multiRemove(model, parametres)` **ASYNCHRONOUS**, Remove rows in the database.
+
+    - `model`: a Model instance with the *database*, *tables*, *fields*, *joins* and other data.
+    - `parametres`: *type* `OBJECT`, with the following `keys` to make the changes:
+        - `filters`: Learn [More](https://github.com/janis-commerce/query-builder/blob/master/docs/Filters.md).
+        - `joins`: Learn [More](https://github.com/janis-commerce/query-builder/blob/master/docs/Joins.md).
+    - **Returns**, `number` of the quantity of rows were removed correctly.
+
 
 - - -