GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2025-01-11 12:32:37 +01:00
Code Issues Projects Releases Wiki Activity

README.md: minor edits

Browse Source
This commit is contained in:
Pragmatic Software 2020-01-21 21:24:27 -08:00
parent 3086d96fdc
commit aaa8b88f51
1 changed files with 15 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -5,12 +5,12 @@ PBot is a versatile IRC Bot written in Perl
* [Installation / Quick Start](#installation--quick-start) * [Installation / Quick Start](#installation--quick-start)
* [Features](#features) * [Features](#features)
* [Commands](#commands) * [Commands](#commands)
* [Advanced interpreter](#advanced-interpreter) * [Powerful command interpreter](#powerful-command-interpreter)
* [piping](#piping) * [Piping](#piping)
* [command substitution](#command-substitution) * [Substitution](#substitution)
* [command splitting](#command-splitting) * [Chaining](#chaining)
* [advanced $variable interpolation](#advanced-variable-interpolation) * [Variables](#variables)
* [inline commands](#inline-commands) * [Inline invocation](#inline-invocation)
* [Factoids](#factoids) * [Factoids](#factoids)
* [Code Factoids](#code-factoids) * [Code Factoids](#code-factoids)
* [Plugins](#plugins) * [Plugins](#plugins)
@ -32,23 +32,23 @@ To get up-and-running quickly, check out the [Quick Start guide](doc/QuickStart.
### Commands ### Commands
PBot has several useful core built-in commands. Additional commands can be added to PBot through PBot has several useful built-in commands. Additional commands can be added to PBot through
[Factoids](#factoids) and [Plugins](#plugins). [Factoids](#factoids), [Plugins](#plugins) and [Modules](#modules).
For more information, see the [Commands documentation.](doc/Commands.md) For more information, see the [Commands documentation.](doc/Commands.md)
### Advanced interpreter ### Powerful command interpreter
PBot has an advanced command interpreter with useful functionality. PBot has an powerful command interpreter with useful functionality.
#### piping #### Piping
You can pipe output from one command as input into another command, indefinitely. You can pipe output from one command as input into another command, indefinitely.
<pragma-> !echo hello world | {sed s/world/everybody/} | {uc} <pragma-> !echo hello world | {sed s/world/everybody/} | {uc}
<PBot> HELLO EVERYBODY <PBot> HELLO EVERYBODY
#### command substitution #### Substitution
You can insert the output from another command at any point within a command. This You can insert the output from another command at any point within a command. This
substitutes the command with its output at the point where the command was used. substitutes the command with its output at the point where the command was used.
@ -73,14 +73,14 @@ factoid otherwise it will be expanded first.
<pragma-> !img spaces & stuff <pragma-> !img spaces & stuff
<PBot> https://google.com/search?tbm=isch&q=spaces%20%26%20stuff <PBot> https://google.com/search?tbm=isch&q=spaces%20%26%20stuff
#### command splitting #### Chaining
You can execute multiple commands sequentially as one command. You can execute multiple commands sequentially as one command.
<pragma-> !echo Test! ;;; me smiles. ;;; version <pragma-> !echo Test! ;;; me smiles. ;;; version
<PBot> Test! * PBot smiles. PBot version 2696 2020-01-04 <PBot> Test! * PBot smiles. PBot version 2696 2020-01-04
#### advanced $variable interpolation #### Variables
You can use factoids as variables and interpolate them within commands. You can use factoids as variables and interpolate them within commands.
@ -95,7 +95,7 @@ combine their effects.
<pragma-> !echo $greeting:uc <pragma-> !echo $greeting:uc
<PBot> HELLO, WORLD <PBot> HELLO, WORLD
#### inline commands #### Inline invocation
You can invoke up to three commands inlined within a message. If the message You can invoke up to three commands inlined within a message. If the message
is addressed to a nick, the output will also be addressed to them. is addressed to a nick, the output will also be addressed to them.