dualsense-ts 0.0.100 → 1.0.4

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.
Files changed (2) hide show
  1. package/README.md +21 -2
  2. package/package.json +5 -3
package/README.md CHANGED
@@ -1,9 +1,28 @@
1
1
  # dualsense-ts
2
2
 
3
- This library provides convenient, strictly type-safe tools for interfacing with a Playstation 5 Dualsense controller.
3
+ This module provides a natural interface for your DualSense controller, so you can focus on input and forget about the device.
4
4
 
5
5
  ## Getting started
6
6
 
7
+ ### Installation
8
+
9
+ This package is distributed via npm: [dualsense-ts](https://npmjs.org/package.dualsense-ts)
10
+
11
+ Install it using your preferred package manager:
12
+
13
+ - `yarn add dualsense-ts`
14
+ - `npm add dualsense-ts`
15
+
16
+ #### Heads up!
17
+
18
+ `dualsense-ts` is an ES module (esm), and uses ES import resolution. To use this module in Node.js, you'll need to take these steps:
19
+
20
+ 1. Use Node.js v16+, or the `--experimental-modules` flag while invoking `node`
21
+ 2. Use the `--experimental-specifier-resolution=node` flag while invoking `node`
22
+ 3. Set `"type": "module"` in your `package.json`
23
+
24
+ (if you're familiar with a way to make the package more backwards-compatible, please help me out by opening a PR!)
25
+
7
26
  ### Connecting
8
27
 
9
28
  By default, `dualsense-ts` will try to connect to the first Dualsense controller it finds.
@@ -88,7 +107,7 @@ for await (const { left, right, up, down } of controller.dpad) {
88
107
 
89
108
  ## Other features
90
109
 
91
- Not much else is supported yet. Check out the [roadmap](./ROADMAP.md) for more info about upcoming features.
110
+ Check out the [roadmap](./ROADMAP.md) for more info about upcoming features.
92
111
 
93
112
  ## Credits
94
113
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "dualsense-ts",
3
- "version": "0.0.100",
4
- "description": "Provides a fluent API for the DualSense controller, with Typescript",
3
+ "version": "1.0.4",
4
+ "description": "A natural interface for your DualSense controller, with Typescript",
5
5
  "keywords": [
6
6
  "dualsense",
7
7
  "typescript",
@@ -9,7 +9,9 @@
9
9
  "node",
10
10
  "strictly-typed",
11
11
  "ps5",
12
- "dualshock"
12
+ "dualshock",
13
+ "playstation",
14
+ "esm"
13
15
  ],
14
16
  "homepage": "https://github.com/nsfm/dualsense-ts",
15
17
  "repository": {