Release v1.2.0

timokroeger · Nov 21, 2021 · 716ecc7 · 716ecc7
1 parent 1b09930
commit 716ecc7
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 
+## [1.2.0] - 2021-11-21
+
 ### Added
 - Option to run at system startup, configurable from the tray icon popup menu
 - Load configuration file from executable directory if now found in current working directory

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "kbremap"
 description = "Custom keyboard layouts for windows"
-version = "1.1.0"
+version = "1.2.0"
 authors = ["Timo Kröger <timokroeger93@gmail.com>"]
 edition = "2021"
 license = "MIT/Apache-2.0"

diff --git a/README.md b/README.md
@@ -3,21 +3,23 @@
 ```
 Usage: kbremap.exe [--config <config>]
 
-Custom keyboard layouts for windows. Fully configurable for quick prototyping of new layouts.
+Custom keyboard layouts for windows.
 
 Options:
   --config          path to configuration file (default: `config.toml`)
   --help            display usage information
 ```
 
 Configuration loosely inspired by custom keyboard firmware like [QMK](https://qmk.fm/).
+Comments in the `config.toml` file explain how to configure the Dvorak layout.
 
 ## Features
 * Remap any key to any other key
-* Supports Unicode characters, including most Emojis 😊
-* Support for any number of virtual layers
-* Click on tray icon enables or bypasses the layout
+* Supports Unicode characters, including most Emojis ⌨️🔥
+* Virtual layers support (e.g. right alt to overlay arrow keys for navigation)
 * No installation or administrator rights required
+* Double-click on tray icon disables the layout
+* Option to run at system startup
 * Uses the windows low-level keyboard hook for maximum compatibility
 
 ## Features `neo.toml` configuration
@@ -27,6 +29,7 @@ Configuration loosely inspired by custom keyboard firmware like [QMK](https://qm
 
 ## Known issues
 * Layer locking not supported
+* Compose key not avaible (yet)
 * Layer "base" must exists in the configuration
 
 ## License

diff --git a/config.toml b/config.toml
@@ -3,6 +3,7 @@
 # Set to `true` to disable caps lock.
 # Useful when the caps lock is remapped but the caps lock state is toggled externally
 # for example by RDP or other programs running with admin rights.
+# The Dvorak layout does not overwrite the caps lock key. Keep the default caps lock behavoir.
 disable_caps_lock = false
 
 [layers]