some documentation fixes
This commit is contained in:
parent
d08d91205d
commit
5b10e75b94
|
@ -78,8 +78,9 @@
|
|||
<li><a href="doc/8_custom.md">Customize bashbot environment</a></li>
|
||||
<li><a href="examples/README.md">Examples</a></li>
|
||||
</ul>
|
||||
<h3 id="i-dont-like-the-many-bashbot-files">I don’t like the many bashbot files</h3>
|
||||
<p>At the beginning bashbot was simply the file <code>bashbot.sh</code> I can copy everywhere and run the bot. Now we have ‘commands.sh’, ‘mycommands.sh’, ’modules/*.sh’ and much more. Hey no Problem, if you are finished with your cool bot simply run <code>dev/make-standalone.sh</code> to create a a stripped down Version containing only ‘bashbot.sh’ and ‘commands.sh’! For more information see <a href="doc/7_develop.md">Create a stripped down Version of your Bot</a></p>
|
||||
<h4 id="you-dont-like-the-many-bashbot-files">You don’t like the many bashbot files?</h4>
|
||||
<p>At the beginning bashbot was simply the file <code>bashbot.sh</code> I can copy everywhere and run the bot. Now we have ‘commands.sh’, ‘mycommands.sh’, ’modules/*.sh’ and much more.</p>
|
||||
<p>Hey no Problem, if you are finished with your cool bot simply run <code>dev/make-standalone.sh</code> to create a stripped down Version containing only ‘bashbot.sh’ and ‘commands.sh’! For more information see <a href="doc/7_develop.md">Create a stripped down Version of your Bot</a></p>
|
||||
<h2 id="security-considerations">Security Considerations</h2>
|
||||
<p>Running a Telegram Bot means it is connected to the public and you never know whats send to your Bot.</p>
|
||||
<p>Bash scripts in general are not designed to be bullet proof, so consider this Bot as a proof of concept. Bash programmers often struggle with ‘quoting hell’ and globbing, see <a href="https://unix.stackexchange.com/questions/171346/security-implications-of-forgetting-to-quote-a-variable-in-bash-posix-shells">Implications of wrong quoting</a></p>
|
||||
|
@ -105,6 +106,6 @@
|
|||
<p><span class="citation">@Gnadelwartz</span></p>
|
||||
<h2 id="thats-it">That’s it!</h2>
|
||||
<p>If you feel that there’s something missing or if you found a bug, feel free to submit a pull request!</p>
|
||||
<h4 id="version-v0.80-dev2-4-gb7df57a"><br /><span class="math display"><em>V</em><em>E</em><em>R</em><em>S</em><em>I</em><em>O</em><em>N</em></span><br /> v0.80-dev2-4-gb7df57a</h4>
|
||||
<h4 id="version-v0.80-dev2-5-gd08d912"><br /><span class="math display"><em>V</em><em>E</em><em>R</em><em>S</em><em>I</em><em>O</em><em>N</em></span><br /> v0.80-dev2-5-gd08d912</h4>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -58,9 +58,10 @@ Bashbot [Documentation](https://github.com/topkecleon/telegram-bot-bash) and [Do
|
|||
* [Examples](examples/README.md)
|
||||
|
||||
|
||||
### I don't like the many bashbot files
|
||||
#### You don't like the many bashbot files?
|
||||
At the beginning bashbot was simply the file ```bashbot.sh``` I can copy everywhere and run the bot. Now we have 'commands.sh', 'mycommands.sh', 'modules/*.sh' and much more.
|
||||
Hey no Problem, if you are finished with your cool bot simply run ```dev/make-standalone.sh``` to create a a stripped down Version containing only
|
||||
|
||||
Hey no Problem, if you are finished with your cool bot simply run ```dev/make-standalone.sh``` to create a stripped down Version containing only
|
||||
'bashbot.sh' and 'commands.sh'! For more information see [Create a stripped down Version of your Bot](doc/7_develop.md)
|
||||
|
||||
## Security Considerations
|
||||
|
@ -104,4 +105,4 @@ Well, thats a damn good question ... may be because I'm an Unix/Linux admin from
|
|||
|
||||
If you feel that there's something missing or if you found a bug, feel free to submit a pull request!
|
||||
|
||||
#### $$VERSION$$ v0.80-dev2-4-gb7df57a
|
||||
#### $$VERSION$$ v0.80-dev2-5-gd08d912
|
||||
|
|
|
@ -65,12 +65,13 @@ all](https://core.telegram.org/bots#3-how-do-i-create-a-bot)
|
|||
* [Examples](examples/README.md)
|
||||
|
||||
|
||||
### I don't like the many bashbot files
|
||||
#### You don't like the many bashbot files?
|
||||
At the beginning bashbot was simply the file ```bashbot.sh``` I can copy
|
||||
everywhere and run the bot. Now we have 'commands.sh', 'mycommands.sh',
|
||||
'modules/*.sh' and much more.
|
||||
|
||||
Hey no Problem, if you are finished with your cool bot simply run
|
||||
```dev/make-standalone.sh``` to create a a stripped down Version containing only
|
||||
```dev/make-standalone.sh``` to create a stripped down Version containing only
|
||||
'bashbot.sh' and 'commands.sh'! For more information see [Create a stripped
|
||||
down Version of your Bot](doc/7_develop.md)
|
||||
|
||||
|
@ -147,4 +148,4 @@ health status
|
|||
If you feel that there's something missing or if you found a bug, feel free to
|
||||
submit a pull request!
|
||||
|
||||
#### $$VERSION$$ v0.80-dev2-4-gb7df57a
|
||||
#### $$VERSION$$ v0.80-dev2-5-gd08d912
|
||||
|
|
|
@ -24,7 +24,7 @@ Let's create a stripped down version:
|
|||
|
||||
- delete all modules you do not need from 'modules', e.g. 'modules/inline.sh' if you don't use inline queries
|
||||
- delete not needed standard commands and messages from 'commands.sh'
|
||||
- delete not neede commands and functions from 'mycommands.sh'
|
||||
- delete not needed commands and functions from 'mycommands.sh'
|
||||
- run ```dev/make-standalone.sh``` to create a a stripped down version of your bo
|
||||
|
||||
Now have a look at the directory 'standalone', here you find the files 'bashbot.sh' and 'commands.sh' containing everything to run your bot.
|
||||
|
@ -145,5 +145,5 @@ fi
|
|||
#### [Prev Function Reference](6_reference.md)
|
||||
#### [Next Bashbot Environment](8_custom.md)
|
||||
|
||||
#### $$VERSION$$ v0.80-dev2-4-gb7df57a
|
||||
#### $$VERSION$$ v0.80-dev2-5-gd08d912
|
||||
|
||||
|
|
Loading…
Reference in New Issue