Skip to content

Commit

Permalink
Update documentation, add custom_scripts dir
Browse files Browse the repository at this point in the history
  • Loading branch information
lorcalhost committed Jul 21, 2021
1 parent fce0d9e commit d271e8d
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ You can also add the bot to a group if multiple people need to access this bot.

## Support the project

I am currently a broke university student, if you like my work and use it on a daily basis consider supporting the project through a small donation. :smile:
If you like `BTB-manager-telegram` and use it on a daily basis consider supporting the project through a small donation. :smile:

[:heart: Sponsor on GitHub](https://github.com/sponsors/lorcalhost)

Expand Down
Empty file added custom_scripts/.gitkeep
Empty file.
12 changes: 5 additions & 7 deletions docs/custom-scripts.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ For example if one wants a button called `List files` which executes the `ls -la
}
```

Multiple scripts can be setup by adding a new line to the json file like so:
Multiple scripts can be setup by adding a new line to the json file like so (note the `,` when adding a new line):

```json
{
Expand All @@ -30,14 +30,12 @@ Multiple scripts can be setup by adding a new line to the json file like so:

## Further information

By default, all scripts are executed from `BTB-manager-telegram`'s directory.
By default, all scripts are executed from within `BTB-manager-telegram`'s directory.

It is recommended to create a `custom_scripts` directory in order to avoid confusion:
It is recommended to use the `custom_scripts` directory in order to avoid confusion:

```bash
cd /path/to/the/BTB-manager-telegram
mkdir custom_scripts
cd custom_scripts
cd /path/to/the/BTB-manager-telegram/custom_scripts
```

## Example custom script installation
Expand All @@ -50,7 +48,7 @@ Make the script executable by giving execute permissions:
chmod +x custom_progress.sh
```

In our example, the script uses sqlite3, so it is necessary to install it via system package manager:
In our example, the script uses `sqlite3`, so it is necessary to install it via system package manager:

```bash
sudo apt install sqlite3
Expand Down
2 changes: 1 addition & 1 deletion docs/telegram-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ urls:
```
Note:
_Binance Trade Bot Manager Telegram_ you can also decide to put a group chat id instead of a personal `chat_id`.
_Binance Trade Bot Manager Telegram_ also supports usage of a group chat id instead of a personal `chat_id`.

[@botfather]: https://t.me/botfather
[@userinfobot]: https://t.me/userinfobot

0 comments on commit d271e8d

Please sign in to comment.