diff --git a/README.md b/README.md index 9678e93..8f543c0 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,22 @@ If you are using a Chromium v89+ based browser, you can try out the library righ ## Installation +### To use in Node.js + ``` $ npm install --save xkeys or $ yarn add xkeys ``` +### To use in browser + +``` +$ npm install --save xkeys-webhid +or +$ yarn add xkeys-webhid +``` + ### Linux On linux, the udev subsystem blocks access for non-root users to the X-keys without some special configuration. Save the following to `/etc/udev/rules.d/50-xkeys.rules` and reload the rules with `sudo udevadm control --reload-rules` diff --git a/packages/core/README.md b/packages/core/README.md index 27d1be0..fd9b686 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -1,6 +1,6 @@ # X-keys - Core -This folder contains the platform-agnostic parts of the X-keys library. +This package contains the platform-agnostic parts of the X-keys library. -*You should not be importing this package directly, instead you will want to do so via one of the wrapper libraries to provide the appropriate HID bindings for your target platform, see [https://github.com/SuperFlyTV/xkeys](https://github.com/SuperFlyTV/xkeys)* +*You should not be importing this package directly, instead you'll want to use one of the wrapper libraries to provide the appropriate HID bindings for your target platform, see [https://github.com/SuperFlyTV/xkeys](https://github.com/SuperFlyTV/xkeys)* diff --git a/packages/node/README.md b/packages/node/README.md index 3ed0571..dc1f06e 100644 --- a/packages/node/README.md +++ b/packages/node/README.md @@ -1,5 +1,5 @@ # X-keys - Node.js -This folder contains the Node.js-specific implementation of the X-keys library. +This package contains the Node.js-specific implementation of the X-keys library. See documentation at [https://github.com/SuperFlyTV/xkeys](https://github.com/SuperFlyTV/xkeys). diff --git a/packages/node/package.json b/packages/node/package.json index a3cd992..d2f062f 100644 --- a/packages/node/package.json +++ b/packages/node/package.json @@ -1,7 +1,7 @@ { "name": "xkeys", "version": "2.1.0", - "description": "An npm module for interfacing with the X-keys panel in Node.js", + "description": "An npm module for interfacing with the X-keys panels in Node.js", "main": "dist/index.js", "typings": "dist/index.d.ts", "license": "MIT", diff --git a/packages/webhid/README.md b/packages/webhid/README.md index 50e7828..ba218f0 100644 --- a/packages/webhid/README.md +++ b/packages/webhid/README.md @@ -1,5 +1,5 @@ # X-keys - WebHID -This folder contains the WebHID-specific implementation of the X-keys library (to be used in browsers). +This package contains the WebHID-specific implementation of the X-keys library (to be used in browsers). See documentation at [https://github.com/SuperFlyTV/xkeys](https://github.com/SuperFlyTV/xkeys). diff --git a/packages/webhid/package.json b/packages/webhid/package.json index 057952c..11da2cb 100644 --- a/packages/webhid/package.json +++ b/packages/webhid/package.json @@ -1,7 +1,7 @@ { "name": "xkeys-webhid", "version": "2.1.0", - "description": "An npm module for interfacing with the X-keys in the browser", + "description": "An npm module for interfacing with the X-keys panels in a browser", "main": "dist/index.js", "typings": "dist/index.d.ts", "license": "MIT",