update readme and bump version

4yn · Mar 16, 2022 · 8c96763 · 8c96763
1 parent 748a76c
commit 8c96763
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -12,6 +12,10 @@ Software adapter for various Chunithm slider controllers with a built-in Brokeni
 
 ## Changelog
 
+- v0.2.3
+  - Fix first and last buttons not working with brokenithm
+  - Add option to disable air strings for controllers
+  - Add option to slow down lighting updates
 - v0.2.2
   - Retcon serial slider name
   - Fix crash on some systems due to time math
@@ -28,7 +32,7 @@ Software adapter for various Chunithm slider controllers with a built-in Brokeni
 ## Setup Instructions
 
 1. [Download here](https://github.com/4yn/slidershim/releases/latest)
-2. Extract to any location you like.
+2. Run the msi installer (recommended for first run) or extract zip to any location you like.
 3. Run `slidershim.exe`.
 4. Pick your input device, output method and preferred lighting.
 5. Click apply.
@@ -46,6 +50,7 @@ Software adapter for various Chunithm slider controllers with a built-in Brokeni
 
 1. Set the device option to "Brokenithm" and apply.
 2. Allow firewall access to `slidershim.exe`
+   > For more info on setting up firewall, check out [instructions at brokenithm-kb](https://github.com/4yn/brokenithm-kb#setup)
 3. Connect a touch device to the same wifi or local network as your windows machine
    > Windows hotspot works too, but make sure to give "public" firewall access
 4. Open the web controller in your tablet device web browser. One of the links should work.
@@ -61,6 +66,13 @@ Voltex layout disables air tower, Neardayo layout enables air tower.
 
 ## Troubleshooting
 
+<details>
+<summary><strong>slidershim crashes when I am running it for the first time</strong></summary>
+
+- Use the .msi installer file instead of the .zip. You may be missing some windows addons that the installer will take care of (specifically Edge WebView).
+
+</details>
+
 <details>
 <summary><strong>My controller is not recognised</strong></summary>
 

diff --git a/src-tauri/Cargo.lock b/src-tauri/Cargo.lock
diff --git a/src-tauri/Cargo.toml b/src-tauri/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "slidershim"
-version = "0.2.2"
+version = "0.2.3"
 description = "slidershim"
 authors = ["4yn"]
 license = ""

diff --git a/src-tauri/README.txt b/src-tauri/README.txt
@@ -2,13 +2,17 @@
  ___| (_) __| | ___ _ __ ___| |__ (_)_ __ ___  
 / __| | |/ _` |/ _ \ '__/ __| '_ \| | '_ ` _ \ 
 \__ \ | | (_| |  __/ |  \__ \ | | | | | | | | |
-|___/_|_|\__,_|\___|_|  |___/_| |_|_|_| |_| |_| v0.2.2
+|___/_|_|\__,_|\___|_|  |___/_| |_|_|_| |_| |_| v0.2.3
 =============================================== 
 
 https://github.com/4yn/slidershim
 
 # Changelog
 
+- v0.2.3
+  - Fix first and last buttons not working with brokenithm
+  - Add option to disable air strings for controllers
+  - Add option to slow down lighting updates
 - v0.2.2
   - Retcon serial slider name
   - Fix crash on some systems due to time math
@@ -20,4 +24,4 @@ https://github.com/4yn/slidershim
   - Added support for serial slider protocol
   - Added 16 key keyboard layout
 - v0.1.4
-  - Initial public release
+  - Initial public release
diff --git a/src-tauri/tauri.conf.json b/src-tauri/tauri.conf.json
@@ -1,7 +1,7 @@
 {
   "package": {
     "productName": "slidershim",
-    "version": "0.2.2"
+    "version": "0.2.3"
   },
   "build": {
     "distDir": "../public",