GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2024-11-25 05:19:29 +01:00
Code Issues Projects Releases Wiki Activity

docs: Fix broken link; describe user-capability groups as "roles"

Browse Source
This commit is contained in:
Pragmatic Software 2023-08-19 16:44:26 -07:00
parent fe3e7c80cb
commit 59b7ee7115
No known key found for this signature in database
GPG Key ID: CC916B6E3C84ECCE
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -272,7 +272,7 @@ Applet | Description
[C-to-English translator](applets/c2english) | Translates C code to natural English sentences. [C-to-English translator](applets/c2english) | Translates C code to natural English sentences.
[C precedence analyzer](applets/paren) | Adds parentheses to C code to demonstrate precedence. [C precedence analyzer](applets/paren) | Adds parentheses to C code to demonstrate precedence.
[C Jeopardy! game](applets/cjeopardy) | C programming trivia game based on the Jeopardy! TV game show. [C Jeopardy! game](applets/cjeopardy) | C programming trivia game based on the Jeopardy! TV game show.
[C Standard citations](applets/c11std.pl) | Cite specified sections/paragraphs from the C standard. [C Standard citations](applets/cstd.pl) | Cite specified sections/paragraphs from the C standard.
[Virtual machine](applets/pbot-vm) | Executes arbitrary code and commands within a virtual machine. [Virtual machine](applets/pbot-vm) | Executes arbitrary code and commands within a virtual machine.
[dict.org Dictionary](applets/dict.org.pl) | Interface to dict.org for definitions, translations, acronyms, etc. [dict.org Dictionary](applets/dict.org.pl) | Interface to dict.org for definitions, translations, acronyms, etc.
[Urban Dictionary](applets/urban) | Search Urban Dictionary for definitions. [Urban Dictionary](applets/urban) | Search Urban Dictionary for definitions.
@ -362,7 +362,7 @@ For more information about the virtual machine, see the [Virtual Machine documen
### Powerful user management ### Powerful user management
PBot has powerful yet simple user management functionality and commands. PBot has powerful yet simple user management functionality and commands.
* instead of generic access-levels, [fine-grained user capabilities](doc/Admin.md#user-capabilities) limit what users may do * instead of generic access-levels, PBot uses [fine-grained user capabilities](doc/Admin.md#user-capabilities), which can be grouped into roles such as Admin, ChanOp, Moderator, etc
* user accounts can be global or channel-specific * user accounts can be global or channel-specific
* users can be recognized by hostmask or required to login with password * users can be recognized by hostmask or required to login with password
* users can adjust their [user-metadata](doc/Admin.md#user-metadata-list) with the [`my`](doc/Commands.md#my) command * users can adjust their [user-metadata](doc/Admin.md#user-metadata-list) with the [`my`](doc/Commands.md#my) command

5
doc/Admin.md
View File

@ -165,7 +165,8 @@ list all users from all channels, including global users.
## User capabilities ## User capabilities
PBot uses a user-capability system to control what users can and cannot do. User-capabilities PBot uses a user-capability system to control what users can and cannot do. User-capabilities
provides fine-grained permissions over various PBot functionality. provides fine-grained permissions over various PBot functionality. User-capabilities may be
grouped into roles such as Admin, ChanOp, Moderator, and other user-defined roles.
### Introduction ### Introduction
For example, imagine a user named alice. alice has no capabilities granted yet. For example, imagine a user named alice. alice has no capabilities granted yet.
@ -238,7 +239,7 @@ If `[capability]` is omitted, the command will list all available capabilities.
#### Grouping capabilities #### Grouping capabilities
Capabilities can be grouped together into a collection, which can then be applied to a user. Capabilities can be grouped together into a collection or role, which can then be applied to a user.
Capability groups can contain nested groups. Capability groups can contain nested groups.
In the [listing capabilities](#listing-capabilities) example, the `admin` capability is In the [listing capabilities](#listing-capabilities) example, the `admin` capability is