osmarks/wyvern
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add a small usage section

Browse Source
This commit is contained in:
osmarks 2018-08-13 10:01:05 +01:00
parent 338f75d599
commit 9fa093d948
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -47,4 +47,8 @@ Configuration is stored in `wyvern_config.tbl` in lua table syntax as used by `t
* Inserting/extracting items manually into/out of chests will result in the index being desynchronised with the actual items. To correct the index, run `reindex` in the CLI client.
* If you try and extract items when the storage server is still starting up, it may fail, as not all chests will have been indexed yet.
* There are currently small problems with extracting certain quantities of items from storage. Yes, it should probably be by stack.
* Yes, I am kind of using git wrong, but editing networked CC programs sanely is *very hard*. Tell me if you find a better solution.
* Yes, I am kind of using git wrong, but editing networked CC programs sanely is *very hard*. Tell me if you find a better solution.
## Usage
Once configured, the chest backend can just be plugged in and ignored, unless it explodes.
For help using the client, run `help` or `h`.