add README.txt for help command

README.txt

@@ -0,0 +1,110 @@
+bashbot
+-------
+
+A Telegram bot written in bash.
+
+Depends on http://github.com/tmux/tmux[tmux]. Uses
+http://github.com/dominictarr/JSON.sh[JSON.sh].
+
+Written by Drew (@topkecleon), Daniil Gentili (@danogentili), and Kay M
+(@gnadelwartz).
+
+Contributions by JuanPotato, BigNerd95, TiagoDanin, and iicc1.
+
+https://github.com/topkecleon/telegram-bot-bash/releases[Download from
+github]
+
+Released to the public domain wherever applicable. Elsewhere, consider
+it released under the http://www.wtfpl.net/txt/copying/[WTFPLv2].
+
+Install bashbot
+~~~~~~~~~~~~~~~
+
+1.  Go to the directory you want to install bashbot, e.g.
+
+* your $HOME directory (install and run with your user-ID)
+* /usr/local if you want to run as service
+
+1.  Clone the repository:
++
+....
+git clone --recursive https://github.com/topkecleon/telegram-bot-bash
+....
+2.  Change to directory `telegram-bot.bash`, run `./bashbot.sh init` and
+follow the instructions. At this stage you are asked for your Bots token
+given by botfather.
+
+Getting started
+~~~~~~~~~~~~~~~
+
+* link:doc/1_firstbot.md[Create your first telegram bot]
+* link:doc/2_usage.md[Make your own Bot]
+* Managing your own Bot
+* Recieve data
+* Send Messages
+* Send files, location etc.
+* link:doc/3_advanced.md[Advatage Features]
+* Interactive Chats
+* Background Jobs
+* Inline queries
+* link:doc/4_expert.md[Expert Use]
+* Handling UTF-8
+* Run as other user or system service
+* Scedule bashbot from Cron
+
+Security Considerations
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Running a Telegram Bot means you are conneted to the public, you never
+know whats send to your Bot.
+
+Bash scripts in general are not designed to be bullet proof, so consider
+this Bot as a proof of concept. More concret examples of security
+problems is bash's 'quoting hell' and globbing.
+https://unix.stackexchange.com/questions/171346/security-implications-of-forgetting-to-quote-a-variable-in-bash-posix-shells[Implications
+of wrong quoting]
+
+Whenever you are processing input from outside your bot you should
+disable globbing (set -f) and carefully quote everthing.
+
+To improve you scripts we recommend to lint them with
+https://www.shellcheck.net/[shellcheck]. This can be done online or you
+can https://github.com/koalaman/shellcheck#installing[install shellcheck
+locally]. bashbot itself is also linted by shellcheck.
+
+Run your Bot as a restricted user
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Every file your bot can write is in danger to be overwritten/deleted, In
+case of bad handling of user input every file your Bot can read is in
+danger of being disclosed.
+
+Never run your Bot as root, this is the most dangerous you can do!
+Usually the user 'nobody' has almost no rigths on Unix/Linux systems.
+See Expert use on how to run your Bot as an other user.
+
+Secure your Bot installation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Everyone who can read your Bot files can extract your Bots data.
+Especially your Bot Token in `token` must be protected against other
+users. No one exept you should have write access to the Bot files. The
+Bot itself need write access to `count` and `tmp-bot-bash` only, all
+other files should be write protected.
+
+Runing `./bashbot.sh init` sets the Bot permissions to reasonable
+default values as a starting point.
+
+Is this Bot insecure?
+^^^^^^^^^^^^^^^^^^^^^
+
+No - its not less (in)secure as any other Bot written in any other
+language. But you should know about the implications ...
+
+That's it!
+~~~~~~~~~~
+
+If you feel that there's something missing or if you found a bug, feel
+free to submit a pull request!
+
+++++++++++++++++++++++++++++++++++++++++++++

bashbot.sh

@@ -10,7 +10,7 @@
 # This file is public domain in the USA and all free countries.
 # Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
 #
-#### $$VERSION$$ v0.50-15-g275a83b
+#### $$VERSION$$ v0.50-13-g143c122
 #
 # Exit Codes:
 # - 0 sucess (hopefully)
@@ -621,7 +621,7 @@ case "$1" in
 		;;
 	"help")
 		$CLEAR
-		less "README.md"
+		less "README.txt"
 		exit
 		;;
 	"attach")

commands.sh

@@ -4,7 +4,7 @@
 # This file is public domain in the USA and all free countries.
 # Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
 #
-#### $$VERSION$$ v0.50-15-g275a83b
+#### $$VERSION$$ v0.6-dev2-0-g143c122
 #
 # shellcheck disable=SC2154
 # shellcheck disable=SC2034