From 37c0bb677cbda4a8c6bf997a258dc97cd70b8fcb Mon Sep 17 00:00:00 2001 From: Pragmatic Software Date: Mon, 17 Feb 2020 14:46:09 -0800 Subject: [PATCH] README.md: improvements --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 0a71e8d0..5abde9e9 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ PBot is a versatile IRC Bot written in Perl * [Channel management](#channel-management) * [User management](#user-management) * [Easy configuration](#easy-configuration) - * [Extensible](#extensible) + * [Reload core modules without disconnecting](#reload-core-modules-without-disconnecting) * [Powerful command interpreter](#powerful-command-interpreter) * [Piping](#piping) * [Substitution](#substitution) @@ -16,6 +16,7 @@ PBot is a versatile IRC Bot written in Perl * [Variables](#variables) * [Inline invocation](#inline-invocation) * [Background processing](#background-processing) + * [Extensible](#extensible) * [Factoids](#factoids) * [Code Factoids](#code-factoids) * [Plugins](#plugins) @@ -77,9 +78,14 @@ These settings can easily be configured via several methods: For more information, see the [Registry documentation.](doc/Registry.md) -### Extensible -PBot is extensible in multiple ways. Additional commands and functionality can be added to PBot through -[Factoids](#factoids), [Plugins](#plugins), [Modules](#modules) and [Functions](#functions). +### Reload core modules without disconnecting +Suppose you edit some PBot source file, be it a core file such as PBot/Factoids.pm or +a Plugin such as Plugins/Wttr.pm. Or suppose there's a PBot update available. + +Most simple bots would require you to shut down the bot and restart it in order +to see the modifications. Not PBot! Rather than shut PBot down and restart it, you +can simply use the [`refresh`](doc/Admin.md#refresh) command to reload all modified PBot +core files and Plugins. ### Powerful command interpreter PBot has an powerful command interpreter with useful functionality, and tons of @@ -157,6 +163,10 @@ The familiar [`ps`](doc/Admin.md#ps) and [`kill`](doc/Admin.md#kill) commands ca You can also [`cmdset`](doc/Admin.md#cmdset) the `process-timeout` [command metadata](doc/Admin.md#command-metadata-list) to set the timeout, in seconds, before the command is automatically killed. Otherwise the `processmanager.default_timeout` [registry value](doc/Registry.md) will be used. +### Extensible +PBot is extensible in multiple ways. Additional commands and functionality can be added to PBot through +[Factoids](#factoids), [Plugins](#plugins), [Modules](#modules) and [Functions](#functions). + ### Factoids Factoids are a very special type of command. Anybody interacting with PBot can create, edit, delete and invoke factoids. Factoids can be locked by the