Settings + readme

README.md

@@ -4,39 +4,96 @@ https://github.com/welcoMattic/kymsu
 
 
 
-### Plug-ins:
+## Plug-ins:
 
 - **atom** (plug-ins)
 - **homebrew**  (brew and cask)
 - **installed** (create a list of all your brew, pip, npm... stuffs). 
-- **npm** (javascript package) (local or global package)
-- **mas** (Mac Appstore) plugin for KYMSU
+- **npm** (javascript package) (local or global packages)
+- **mas** (Mac Appstore)
 - **pip** (Python Package index) (pip or pip3)
 - **PECL** (PHP modules)
 - **Wordpress** (wp-cli) (for testing only)
 
+ 
 
-
-### Requirements
+## Requirements
 
 - [Homebrew](https://brew.sh/)
 - [pipdeptree](https://pypi.python.org/pypi/pipdeptree) for checking dependancies (pip plugin)
 
 
 
-### Installation
+## Installation
 
-`$ git clone git@github.com:Bruno21/kymsu.git && cd kymsu && ./install.sh`
+`$ git clone git@github.com:Bruno21/kymsu.git && cd kymsu2 && ./install.sh`
+
+A symbolic link is created in `/usr/local/bin/`
+
+Plug-ins are placed in `~/.kymsu/`
 
 
 
-### Credit
+## Usage
+
+Only update all the things:  `$ kymsu2` 
+
+With cleanup after updates: `$ kymsu2 --cleanup`
+
+No distract mode  (no user interaction):`$ kymsu2 --nodistract`
+
+Prefix plugin with a _ to ignore it:
+
+```bash
+# _wp.sh is disabled (still beta)
+~/.kymsu/plugins.d $ ls
+00-kymsu.sh _wp.sh      atom.sh     homebrew.sh mas.sh      npm.sh      pecl.sh     pip.sh
+```
+
+
+
+## Settings
+
+ There is a <u>settings section</u> on top of each plug-in:
+
+- *[homebrew-pip]* don't update a module, package...: add it to the `do_not_update` array on the top.
+
+```bash
+$ nano homebrew.sh
+declare -a do_not_update=('virtualbox,virtualbox-extension-pack')
+```
+
+- *[homebrew]* display info on updated pakages: `display_info=true`
+- *[homebrew-npm-pecl-pip]* no distract mode  (no user interaction): `no_distract=false`
+  *If running Homebrew plug-in in no_distract mode, Casks with 'latest' version number won't be updated.*
+- *[npm]* run npm maintenance tools: `doctor=true`
+- *[pip]* `version=pip or pip3`  `user="" or "--user"`
+
+
+
+## Update
+
+Git pull and re-run install.sh:
+
+`$ cd kymsu2 && git pull && ./install.sh`
+
+
+
+## Uninstall
+
+Run uninstall.sh:
+
+`$ cd kymsu2 && ./uninstall.sh`
+
+
+
+## Credit
 
 All credit goes to [welcoMattic](https://github.com/welcoMattic/kymsu)
 
 
 
-### License
+## License
 
 Same as KYMSU (MIT)