keycomfort 0.1.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,33 @@
1
- # KEYCONFORT
1
+ # KEYCOMFORT
2
+ Comfortable keyboard remaps for Karabiner.
3
+
4
+ ## Installation
5
+ Keycomfort is a command line application.
6
+ Install it via NPM with `-g` option.
7
+
8
+ ```sh
9
+ npm i -g keycomfort
10
+ ```
11
+
12
+ ## Usage
13
+
14
+ ```sh
15
+ Usage: keycomfort [options] [command]
16
+
2
17
  Comfortable keyboard remaps for Karabiner/AutoHotKey
3
18
 
4
- ## This is still in beta!
5
- Please wait for 1.0.0 release.
19
+ Options:
20
+ -V, --version output the version number
21
+ -v, --verbose output detailed messages for debug
22
+ -h, --help display help for command
23
+
24
+ Commands:
25
+ configure|config [options] [file] create/edit/reset/delete config
26
+ generate|gen [options] [target] generate keymaps
27
+ help [command] display help for command
28
+
29
+ ```
30
+
31
+ ## License
32
+ MIT © 2025 [Satoshi Soma](https://github.com/amekusa)
6
33