add examples to the docs

develop
Myk Taylor 2023-07-21 04:17:57 -07:00
parent dff4816287
commit b25266367d
No known key found for this signature in database
GPG Key ID: 8A39CA0FA0C16E78
1 changed files with 15 additions and 0 deletions

@ -11,6 +11,9 @@ Caretaker labor enabled will come to the hospital to treat the animals. Normal
medical skills are used (and trained), but no experience is given to the Animal
Caretaker skill itself.
You can enable ``dwarfvet`` in `gui/control-panel`, and you can choose to start
``dwarfvet`` automatically in new forts in the ``Autostart`` tab.
Usage
-----
@ -18,3 +21,15 @@ Usage
enable dwarfvet
dwarfvet [status]
dwarfvet now
Examples
--------
``dwarfvet``
Report on how many animals are being treated and how many are in need of
treatment.
``dwarfvet now``
Assign injured animals to a free floor spot in a nearby hospital,
regardless of whether the plugin is enabled.