clear-branches - npm Package Compare versions

Comparing version 0.0.6 to 0.0.7

package.json

 {
   "name": "clear-branches",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "productivity and easy way to clear your local branches",
@@ -5,0 +5,0 @@ "main": "clearBranches.js",

README.md

@@ -1,4 +0,8 @@
-# Clear Branches
-Productivy and easy way to clear your local branches *(This library is not finished yet, it isn't working well)*
+# Clear Branches (Alpha)
+> *(This library is not finished yet, it could be not working well in some environments)*
 
+Productivy and easy way to clear your local branches 
+
+
+
 ## WIP
@@ -17,5 +21,15 @@ - [x] Setup to run using `clear-branches` or `npx clear-branches`
 #### Install and Run
+If you don't want to install globaly, you can just execute into your git project:
+
+```shell
+$ npx clear-branches
+```
+
+Or installing: 
+
 **yarn:** 
 ```shell 
 $ yarn global add clear-branches
+$ cd your-git-project/
+$ clear-branches
 ```
@@ -26,17 +40,29 @@
 $ npm i -g clear-branches
+$ cd your-project/
+$ clear-branches
 ```
 
-If you don't want to install globaly, you can just execute into your git project:
+#### Usage
 
+Inside your project:
+
 ```shell
-$ npx clear-branches
+$ cd your-git-project/
+$ clear-branches
 ```
 
-#### Usage
+![all-branches](./docs/assets/all-branches.png)
 
-Inside your project:
+You will see all branches that will be deleted to confirm if everything is alright.
+It automatically ignores **master**, **develop** and **release** branches.
 
+#### Options
+
+But, if you want to ignore more banches: 
+
 ```shell
-$ cd your-project/
-$ clear-branches
+clear-branches --ignore=chore/bump-version,feat/finish-scheduling-treatment
 ```
+
+![all-branches](./docs/assets/ignore-branches.png)
+

No alert changes

Improved metrics

Total package byte prevSize

76012

increased by1681.81%

Number of package files

6

increased by50%

Number of lines in readme file

67

increased by63.41%

No dependency changes