README.md in slack-smart-bot-1.1.2 vs README.md in slack-smart-bot-1.2.0

- old
+ new

@@ -202,11 +202,28 @@ Example: >**_Peter>_** `bot help echo` >**_Smart-Bot>_** `echo SOMETHING` `repeats SOMETHING` +When you call a command that is not recognized, you will get suggestions from the Smart Bot. +Remember when you add code to your rules you need to specify the help that will be displayed when using `bot help`, `bot rules` + +For the examples use _ and for the rules `. This is a good example of a Help supplied on rules source code: + +```ruby +# help: `run TYPE tests on LOCATION` +# help: `execute TYPE tests on LOCATION` +# help: run the specified tests on the indicated location +# help: TYPE: api, ui, smoke, load +# help: LOCATION: customers, db1..db10, global +# help: Examples: +# help: _run api tests on customers_ +# help: _run ui tests on customers_ +# help: _execute smoke tests on db1_ +``` + ### Bot Management To create a new bot on a channel, run on MASTER CHANNEL: **_`create bot on CHANNEL`_**. The admins of this new bot on that channel will be the MASTER ADMINS, the creator of the bot and the creator of that channel. It will create a new rules file linked to this new bot. You can kill any bot running on any channel if you are an admin of that bot: **_`kill bot on CHANNEL`_** @@ -270,12 +287,15 @@ To see available shortcuts: **_`see shortcuts`_** and to delete a particular shortcut: **_`delete shortcut NAME`_** ### Routines To add specific commands to be run automatically every certain amount of time or a specific time: **_`add routine NAME every NUMBER PERIOD COMMAND`_** or **_`add routine NAME at TIME COMMAND`_** +If you want to hide the routine executions use `add silent routine`. It won't show the routine name when executing. + Examples: ->**_`add routine run_tests every 3h run tests on customers`_** ->**_`add routine clean_db at 17:05 clean customers temp db`_** +>**_`add routine run_tests every 3h !run tests on customers`_** +>**_`add routine clean_db at 17:05 !clean customers temp db`_** +>**_`add silent routine clean_db at 17:05 !clean customers temp db`_** Also instead of adding a Command to be executed, you can attach a file, then the routine will be created and the attached file will be executed on the criteria specified. Only Master Admins are allowed to use it this way. Other routine commands: * **_`pause routine NAME`_**