octoleo/telegram-bot-bash
1
1
Fork 0
mirror of https://github.com/octoleo/telegram-bot-bash.git synced 2025-04-11 08:31:51 +00:00
Code Issues Projects Releases Wiki Activity

some doc cleanup

Browse Source
This commit is contained in:
Kay Marquardt (Gnadelwartz) 2020-07-26 13:35:12 +02:00
parent 50e661aa50
commit 38a6198198
4 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/0_install.md
View File

@ -15,7 +15,7 @@ Now your Bot is ready to start ...
**If you are new to Bot development read [Bots: An introduction for developers](https://core.telegram.org/bots)** **If you are new to Bot development read [Bots: An introduction for developers](https://core.telegram.org/bots)**
### Install from Github ### Install from github
As an alternative to download the zip files, you can clone the github repository to get the latest improvements/fixes. As an alternative to download the zip files, you can clone the github repository to get the latest improvements/fixes.
@ -63,7 +63,7 @@ BSD/MacOS sed compatibility will result in a rewrite of all grep/sed commands wi
see [BSD/MacOS vs. GNU sed](https://riptutorial.com/sed/topic/9436/bsd-macos-sed-vs--gnu-sed-vs--the-posix-sed-specification) see [BSD/MacOS vs. GNU sed](https://riptutorial.com/sed/topic/9436/bsd-macos-sed-vs--gnu-sed-vs--the-posix-sed-specification)
to get an impression how different they are. to get an impression how different they are.
If you are a sed guru and can convert the following examples to work correct with gnu and BSD sed, contact me. If you can convert the following examples to work correct with gnu and BSD sed, contact me.
```bash ```bash
# easy start # easy start
@ -131,5 +131,5 @@ The old format is supported for backward compatibility, but may fail for corner
#### [Next Create Bot](1_firstbot.md) #### [Next Create Bot](1_firstbot.md)
#### $$VERSION$$ v0.98-0-g5b5447e #### $$VERSION$$ v0.99-dev2-16-g50e661a

6
doc/1_firstbot.md
View File

@ -1,5 +1,5 @@
#### [Home](../README.md) #### [Home](../README.md)
## Create a Telegram Bot with botfather ## Create a Telegram Bot with Botfather
**[BotFather is the one bot to rule them all](https://core.telegram.org/bots#3-how-do-i-create-a-bot). It will help you create new bots and change settings for existing ones.** [Commands known by Botfather](https://core.telegram.org/bots#generating-an-authorization-token) **[BotFather is the one bot to rule them all](https://core.telegram.org/bots#3-how-do-i-create-a-bot). It will help you create new bots and change settings for existing ones.** [Commands known by Botfather](https://core.telegram.org/bots#generating-an-authorization-token)
### Creating a new Bot ### Creating a new Bot
@ -9,7 +9,7 @@ text: `/newbot`
If you don't know how to message by username, click the search If you don't know how to message by username, click the search
field on your Telegram app and type `@botfather`, you should be able field on your Telegram app and type `@botfather`, you should be able
to initiate a conversation. Be careful not to send it to the wrong to initiate a conversation. Be careful not to send it to the wrong
contact, because some users has similar usernames to `botfather`. contact, because there are users with a similar username.
![botfather initial conversation](http://i.imgur.com/aI26ixR.png) ![botfather initial conversation](http://i.imgur.com/aI26ixR.png)
@ -65,5 +65,5 @@ group. This step is up to you actually.
#### [Prev Installation](0_install.md) #### [Prev Installation](0_install.md)
#### [Next Getting started](2_usage.md) #### [Next Getting started](2_usage.md)
#### $$VERSION$$ v0.98-0-g5b5447e #### $$VERSION$$ v0.99-dev2-16-g50e661a

2
doc/2_usage.md
View File

@ -283,5 +283,5 @@ send_action "${CHAT[ID]}" "action"
#### [Prev Create Bot](1_firstbot.md) #### [Prev Create Bot](1_firstbot.md)
#### [Next Advanced Usage](3_advanced.md) #### [Next Advanced Usage](3_advanced.md)
#### $$VERSION$$ v0.98-0-g5b5447e #### $$VERSION$$ v0.99-dev2-16-g50e661a

3
doc/3_advanced.md
View File

@ -6,7 +6,6 @@ Bashbot offers functions to check what Telegram capabilities like 'chat admin' o
```bash ```bash
# return true if user is admin/owner of the bot # return true if user is admin/owner of the bot
# -> botadmin is stored in file './botadmin'
user_is_botadmin "user" user_is_botadmin "user"
# return true if user is creator or admin of a chat # return true if user is creator or admin of a chat
@ -289,5 +288,5 @@ Note: If you disable automatic retry, se above, you disable also connection prob
#### [Prev Getting started](2_usage.md) #### [Prev Getting started](2_usage.md)
#### [Next Expert Use](4_expert.md) #### [Next Expert Use](4_expert.md)
#### $$VERSION$$ v0.98-0-g5b5447e #### $$VERSION$$ v0.99-dev2-16-g50e661a