bump version

packages/keystrokes/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rwh/keystrokes",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Keystrokes is an easy to use library for binding functions to keys and key combos. It can be used with any TypeScript or JavaScript project, even in non-browser environments.",
   "type": "module",
   "main": "dist/keystrokes.umd.cjs",

packages/keystrokes/readme.md

@@ -56,7 +56,10 @@ If node modules aren't an option for you, you can use an npm CDN such as
 [jsDelivr][jsdelivr] or [UNPKG][unpkg].
 
 ```html
-<script src="https://unpkg.com/browse/@rwh/keystrokes@latest/keystrokes.js">
+<!-- ESM -->
+<script src="https://unpkg.com/browse/@rwh/keystrokes@latest/dist/keystrokes.js">
+<!-- UMD -->
+<script src="https://unpkg.com/browse/@rwh/keystrokes@latest/dist/keystrokes.umd.cjs">
 <script>
 keystrokes.bindKey('a', () => console.log('you pressed a'))
 </script>
@@ -80,15 +83,6 @@ using Keystrokes in. They are always case insensitive. The default behavior,
 intended for browser environments, is to use the value of the key property from
 keyboard events. You get get a list of valid [key names here][key-names].
 
-Key combos are made up of key names and operators. The operators separate the
-key combo into it's parts.
-
-| Operator | Name               | Description
-|----------|--------------------|-----------------------------------------------------
-| +        | Key Unit           | A group of key names. Can be pressed in any order.
-| >        | Group Separator    | Separates key units. Each key unit must be pressed and held in order.
-| ,        | Sequence Separator | Separates groups. Each group must be pressed and released in order. This will be familiar to vim users.
-
 ```js
 import { bindKey, bindKeyCombo } from '@rwh/keystrokes'
 
@@ -308,7 +302,7 @@ If your app uses the global instance of keystrokes then this can be used in
 conjunction with `setGlobalKeystrokes`.
 
 ```js
-import assert from 'assert'
+import { describe, it, expect } from 'vitest'
 import { createTestKeystrokes, setGlobalKeystrokes } from '@rwh/keystrokes'
 
 describe('MyApp', () => {
@@ -323,7 +317,7 @@ describe('MyApp', () => {
 
     await app.update()
 
-    assert(app.didComboBoundThing)
+    expect(app.didComboBoundThing).toBe(true)
   })
 })
 ```
@@ -367,7 +361,7 @@ package associated with the global instance.
 
 Option            | Description
 ------------------|------------------------------------------
-selfReleasingKeys | Some environments may not properly fire release events for all keys. Adding them to this array will ensure they are released automatically when no other keys are pressed.
+selfReleasingKeys | Key names added to selfReleasingKeys will be marked as released after any other key is released. Provided to deal with buggy platforms.
 keyRemap          | An object of key value pairs with the key being the key to rename, and the value being the new name.
 onActive          | A binder to track viewport focus. See [Non Browser Environments](#non-browser-environments) for details.
 onInactive        | A binder to track viewport blur. See [Non Browser Environments](#non-browser-environments) for details.

packages/react-keystrokes/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rwh/react-keystrokes",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "React bindings for Keystrokes, an easy to use library for binding functions to keys and key combos. It can be used with any TypeScript or JavaScript project, even in non-browser environments.",
   "type": "module",
   "main": "dist/react-keystrokes.umd.cjs",

packages/react-keystrokes/readme.md

@@ -56,7 +56,10 @@ If node modules aren't an option for you, you can use an npm CDN such as
 [jsDelivr][jsdelivr] or [UNPKG][unpkg].
 
 ```html
-<script src="https://unpkg.com/browse/@rwh/keystrokes@latest/keystrokes.js">
+<!-- ESM -->
+<script src="https://unpkg.com/browse/@rwh/keystrokes@latest/dist/keystrokes.js">
+<!-- UMD -->
+<script src="https://unpkg.com/browse/@rwh/keystrokes@latest/dist/keystrokes.umd.cjs">
 <script>
 keystrokes.bindKey('a', () => console.log('you pressed a'))
 </script>
@@ -299,7 +302,7 @@ If your app uses the global instance of keystrokes then this can be used in
 conjunction with `setGlobalKeystrokes`.
 
 ```js
-import assert from 'assert'
+import { describe, it, expect } from 'vitest'
 import { createTestKeystrokes, setGlobalKeystrokes } from '@rwh/keystrokes'
 
 describe('MyApp', () => {
@@ -314,7 +317,7 @@ describe('MyApp', () => {
 
     await app.update()
 
-    assert(app.didComboBoundThing)
+    expect(app.didComboBoundThing).toBe(true)
   })
 })
 ```
@@ -358,7 +361,7 @@ package associated with the global instance.
 
 Option            | Description
 ------------------|------------------------------------------
-selfReleasingKeys | Some environments may not properly fire release events for all keys. Adding them to this array will ensure they are released automatically when no other keys are pressed.
+selfReleasingKeys | Key names added to selfReleasingKeys will be marked as released after any other key is released. Provided to deal with buggy platforms.
 keyRemap          | An object of key value pairs with the key being the key to rename, and the value being the new name.
 onActive          | A binder to track viewport focus. See [Non Browser Environments](#non-browser-environments) for details.
 onInactive        | A binder to track viewport blur. See [Non Browser Environments](#non-browser-environments) for details.

packages/vue-keystrokes/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rwh/vue-keystrokes",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Vue 3 bindings for Keystrokes, an easy to use library for binding functions to keys and key combos. It can be used with any TypeScript or JavaScript project, even in non-browser environments.",
   "type": "module",
   "main": "./dist/vue-keystrokes.umd.cjs",

packages/vue-keystrokes/readme.md

@@ -56,7 +56,10 @@ If node modules aren't an option for you, you can use an npm CDN such as
 [jsDelivr][jsdelivr] or [UNPKG][unpkg].
 
 ```html
-<script src="https://unpkg.com/browse/@rwh/keystrokes@latest/keystrokes.js">
+<!-- ESM -->
+<script src="https://unpkg.com/browse/@rwh/keystrokes@latest/dist/keystrokes.js">
+<!-- UMD -->
+<script src="https://unpkg.com/browse/@rwh/keystrokes@latest/dist/keystrokes.umd.cjs">
 <script>
 keystrokes.bindKey('a', () => console.log('you pressed a'))
 </script>
@@ -299,7 +302,7 @@ If your app uses the global instance of keystrokes then this can be used in
 conjunction with `setGlobalKeystrokes`.
 
 ```js
-import assert from 'assert'
+import { describe, it, expect } from 'vitest'
 import { createTestKeystrokes, setGlobalKeystrokes } from '@rwh/keystrokes'
 
 describe('MyApp', () => {
@@ -314,7 +317,7 @@ describe('MyApp', () => {
 
     await app.update()
 
-    assert(app.didComboBoundThing)
+    expect(app.didComboBoundThing).toBe(true)
   })
 })
 ```
@@ -358,7 +361,7 @@ package associated with the global instance.
 
 Option            | Description
 ------------------|------------------------------------------
-selfReleasingKeys | Some environments may not properly fire release events for all keys. Adding them to this array will ensure they are released automatically when no other keys are pressed.
+selfReleasingKeys | Key names added to selfReleasingKeys will be marked as released after any other key is released. Provided to deal with buggy platforms.
 keyRemap          | An object of key value pairs with the key being the key to rename, and the value being the new name.
 onActive          | A binder to track viewport focus. See [Non Browser Environments](#non-browser-environments) for details.
 onInactive        | A binder to track viewport blur. See [Non Browser Environments](#non-browser-environments) for details.