Update 'README.md'

This commit is contained in:
Mute 2022-07-08 03:10:05 +00:00
parent 8d6669795b
commit d30d0c1408
1 changed files with 7 additions and 2 deletions

View File

@ -2,7 +2,7 @@
This document is updated with stable releases, for additional documentation please consult [[the wiki|https://code.fleshless.org/mute/MBCHC/wiki/Home]].
## Stable vs. unstable versions
Stable version is updated less often and after some testing. Hopefully it contains less bugs, but also is behind on new features. By the same token, unstable version is updated more often and with minimal testing by the authors. Think of it as beta versions of the club.
Stable version is updated less often and after some testing. Hopefully it contains less bugs, but also is behind on new features. By the same token, unstable version is updated more often and with minimal testing by the authors. Think of it as beta versions of the club. Trunk version is the least tested and the most updated.
## Loader scripts
These download the corresponding main script, making sure it's always fresh. Most Tampermonkey users should probably use the loader instead of adding the main script directly. Tampermonkey has an update check, but loaders are just more convenient if you want to always have the current version.
@ -20,7 +20,7 @@ None at the moment. Please ask BCE devs to add MBCHC loading if you want to have
4. Refresh the club page and enjoy.
### Bookmarklet
(Doesn't work just yet, need to sort out CORS first.)
(Doesn't work just yet, will be supported in the next release.)
## Scripts
### `mbchc-loader.user.js`
@ -43,6 +43,11 @@ The main script, unstable version.
URL: https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc-dev.user.js
### `mbchc-local.user.js`
The main script, trunk version. (**use this if you really want the latest**).
URL: https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc-local.user.js
## Features
These are new commands this mod adds, use `/help` for syntax.