diff --git a/README.md b/README.md index 4dd4586..9a3c308 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,7 @@ For installation of plugin do the follows: 8. Restart Electron Cash and you now should see the "Shuffle" tab in the main window. +![Server settings](/images/shuffle_tab.png) ## Making a shuffle @@ -67,6 +68,24 @@ If you want to add your server to the list follow the next structure: `port` value should be integer value of your server port and `ssl` should be boolean value of ssl support. +## Running a shuffling bot from plugin + +You can run shuffling bot from plugin with checkin `use bot` checkbox. + +![Bot settings](/images/Bot_tab.png) + +1. Choose server from servers list + +2. Specify minimal number of players in pool to support it + +3. Specify maximum additional player which bot can add to pool + +4. Specify lookup period + +5. Run the bot with `Run bot` button + +6. Stop it with `Stop bot` button if necessary + ## Running a shuffling bot You can run a shuffling bot for supporting of shuffling process. Bot is a simple python script which is looking at the selected cashshuffle server to see if it is a some players in the pool. If it finds a players it also run cahsshuffle protocol clients for mixing. diff --git a/images/Bot_tab.png b/images/Bot_tab.png new file mode 100644 index 0000000..802eb8e Binary files /dev/null and b/images/Bot_tab.png differ