Update 'README.md'

README.md

@@ -1,3 +1,90 @@
-Mute's Bondage Club Hacks Collection
+# Mute's Bondage Club Hacks Collection
+This document is updated with stable releases, for additional documentation please consult [[the wiki|https://code.fleshless.org/mute/MBCHC/wiki/Home]].
 
-[[https://code.fleshless.org/mute/MBCHC/wiki]]
+## 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.
+
+## 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.
+
+On the other hand, if you want to control the script versions yourself, don't use the loader.
+
+## Installation
+### BCE integration
+None at the moment. Please ask BCE devs to add MBCHC loading if you want to have it (seems like a good idea to us).
+
+### Tampermonkey
+1. Install Tampermonkey.
+2. Select a script you want to add below, then click its URL.
+3. Tampermonkey should recognise the script and prompt you for installation.
+4. Refresh the club page and enjoy.
+
+### Bookmarklet
+(Doesn't work just yet, need to sort out CORS first.)
+
+## Scripts
+### `mbchc-loader.user.js`
+The loader script for the stable version (**if unsure, use this**).
+
+URL: https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc-loader.user.js
+
+### `mbchc.user.js`
+The main script, stable version.
+
+URL: https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc.user.js
+
+### `mbchc-loader-dev.user.js`
+The loader script for the unstable version (**use this if you want to help testing**).
+
+URL: https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc-loader-dev.user.js
+
+### `mbchc-dev.user.js`
+The main script, unstable version.
+
+URL: https://code.fleshless.org/mute/MBCHC/raw/branch/master/mbchc-dev.user.js
+
+## Features
+These are new commands this mod adds, use `/help` for syntax.
+
+### /disappear
+This command will make you invisible, if you are wearing an anal hook tied to hair.
+
+You might also want to consider hiding your arousal meter.
+
+### /autohack
+Toggles an autohack mode. Currently this mode starts hacking again as soon as the data gets stolen.
+
+Be informed that autohacking is much less lucrative due to game mechanics. No plans to "fix" this.
+
+### /donate
+Buy data on the black market and send it to someone. Serves as money transfer. Doesn't require anything from the other party except from being restrained. Data will cost you more than it will make, this is by design.
+
+### /nod
+Send a nod activity, as if clicked on the button.
+
+### /shake
+Send a headshake activity, as if clicked on the button.
+
+### /shrug
+Send a shrug activity.
+
+### /myself (or @)
+Send a custom activity as yourself. Example: "@shivers" will send "(YourName shivers.)"
+
+### /activity (or @@)
+Send a custom activity. Example: "@@it starts to rain" will send "(It starts to rain.)"
+
+### /title
+Set a custom title. Currenty only works with the same titles you can select. **Work in progress.**
+
+## Geek corner
+Yes, we are aware of all the nifty git features (branches etc.), we just don't use them.
+This mod is low effort, just enough to work without errors and deliver features we find useful.
+We also have to keep in mind not everyone in the club works in software development, so it needs to be
+as user-friendly as possible.
+
+## Contributing
+Sure, welcome onboard. Please send pull requests, patches, ideas, feedback, feature requests and bug reports.
+
+## Contacts
+Beyond social functions this site provides, you can always find us in the club or drop us an email. We don't use discord.