README.md in fusuma-plugin-sendkey-0.10.1 vs README.md in fusuma-plugin-sendkey-0.11.0

- old
+ new

@@ -36,55 +36,67 @@ $ sudo gem install revdev $ sudo gem install bundler $ sudo gem install fusuma-plugin-sendkey ``` -## List available keys +## List Available Keys ```sh $ fusuma-sendkey -l ``` -If you want to look up a specific key, like the next song or the previous song, the `grep -i` refinement search is useful. +To look up a specific key, such as the next or previous song, you can use the `grep -i` filter. ```sh $ fusuma-sendkey -l | grep -i song NEXTSONG PREVIOUSSONG ``` -## Run fusuma-sendkey on Terminal +## Running fusuma-sendkey on Terminal -* `fusuma-sendkey` command is available on your terminal +* `fusuma-sendkey` command is available on your terminal for testing. * `fusuma-sendkey` supports modifier keys and multiple key presses. -Combine keys for pressing the same time with `+` + - Combine keys for pressing the same time with `+` + - Separate keys for pressing sequentially with `,` +### Example (Sendkey with Modifier Keys) ```sh -$ fusuma-sendkey LEFTCTRL+T # press ctrl key + t key +$ fusuma-sendkey LEFTCTRL+T # Open a new tab ``` +### Example (Sendkey with Multiple Key Presses) + +```sh +$ fusuma-sendkey ["LEFTSHIFT+F10", "T", "ENTER", "ESC"] # Google Translate +``` + Some of the keys found with `fusuma-sendkey -l` may actually be invalid keys. -So test it once with `fusuma-sendkey <KEYCODE>` and then add it to config.yml. +So test them first with `fusuma-sendkey <KEYCODE>` before adding them to config.yml. -## Add sendkey properties to config.yml +## Add Sendkey Properties to config.yml -Add `sendkey:` property in `~/.config/fusuma/config.yml`. +Add the `sendkey:` property in your `~/.config/fusuma/config.yml`. -lines beginning from `#` are comments +Lines beginning with `#` are comments. ```yaml swipe: 3: left: - sendkey: "LEFTALT+RIGHT" # history back + sendkey: "LEFTALT+RIGHT" # History back right: - sendkey: "LEFTALT+LEFT" # history forward + sendkey: "LEFTALT+LEFT" # History forward up: - sendkey: "LEFTCTRL+T" # open new tab + sendkey: "LEFTCTRL+T" # Open a new tab down: - sendkey: "LEFTCTRL+W" # close tab + sendkey: "LEFTCTRL+W" # Close a tab + +hold: + 3: + sendkey: ["LEFTSHIFT+F10", "T", "ENTER", "ESC"] # Translate in Google Chrome ``` ### clearmodifiers - `clearmodifiers: true` option clears other modifier keys before sending @@ -94,34 +106,31 @@ 4: up: keypress: LEFTSHIFT: sendkey: "LEFTMETA+DOWN" - clearmodifiers: true # clear LEFTSHIFT before sending LEFTMETA+DOWN + clearmodifiers: true # Clear LEFTSHIFT before sending LEFTMETA+DOWN ``` +### Specify Keyboard by Device Name -### Specify keyboard by device name +If you encounter the following error message, please set your keyboard name in `plugin.executors.sendkey_executor.device_name` in config.yml. -If you got following error message, try to set your keyboard name to `plugin.executors.sendkey_executor.device_name` on config.yml - -```shell +```sh $ fusuma-sendkey -l sendkey: Keyboard: /keyboard|Keyboard|KEYBOARD/ is not found ``` -Set the following options to recognize keyboard only for the specified keyboard device. -Open `~/.config/fusuma/config.yml` and add the following code at the bottom. +Add the following code to the bottom of `~/.config/fusuma/config.yml` to recognize only the specified keyboard device. ```yaml plugin: executors: sendkey_executor: device_name: 'YOUR KEYBOARD NAME' ``` -**If [fusuma-plugin-remap](https://github.com/iberianpig/fusuma-plugin-remap) is available, it will be automatically connected to `fusuma_virtual_keyboard`, so `device_name` option is not required.** - +**Note**: If [fusuma-plugin-remap](https://github.com/iberianpig/fusuma-plugin-remap) is available, it will automatically connect to `fusuma_virtual_keyboard`, so the `device_name` option is not required. ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/iberianpig/fusuma-plugin-sendkey. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.