Skip to content

Commit

Permalink
chore: doc
Browse files Browse the repository at this point in the history
  • Loading branch information
nytamin committed May 15, 2021
1 parent cfcd442 commit a137551
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 6 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
4 changes: 2 additions & 2 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -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)*

2 changes: 1 addition & 1 deletion packages/node/README.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion packages/node/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/webhid/README.md
Original file line number Diff line number Diff line change
@@ -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).
2 changes: 1 addition & 1 deletion packages/webhid/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit a137551

Please sign in to comment.