docs: 1.3 update

vkiss · Mar 31, 2022 · 3ca0056 · 3ca0056
1 parent 50c1ca6
commit 3ca0056
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 1.3
+> **Publishing date:** 2022-03-31
+
+- **Feat:** JS: options.silent
+- **Feat:** JS: options.callback
+
 ## 1.2
 > **Publishing date:** 2021-10-07
 

diff --git a/README.md b/README.md
@@ -51,6 +51,27 @@ const clearPath = require( "clear-path" );
 clearPath("dist");
 ```
 
+### options
+> These options can only be changed when using `clear-path` in JS.
+
+```js
+clearPath("dist", {
+  silent: true,
+  callback: (files) => {
+    console.log("Deleted theses files: ", files)
+  }
+})
+```
+
+#### options.silent
+
+**Default:** `false`\
+If set to true, will not console log deleted files.
+
+#### options.callback
+
+If you declara a function in your `options.callback`, will execute after deleting files.
+
 ## Multiple clear-path routines
 
 ### Example: package.json

diff --git a/backlog.md b/backlog.md
@@ -1,8 +1,3 @@
 # Feats
 
 - Silent CLI param;
-
-# Docs
-
-- Documentar options;
-- Documentar callback;