Skip to content

Commit 5f8170b

Browse files
committed
update readme
1 parent 62c94bf commit 5f8170b

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,35 @@ Or using [Yarn](https://yarnpkg.com/en/):
2828
yarn add @robotlegsjs/phaser-ce-signalcommandmap
2929
```
3030

31+
From version `0.2.0` of this package, the [Phaser-CE](https://github.com/photonstorm/phaser-ce) dependency was moved to **peerDependencies**,
32+
allowing the final user to choose the desired version of the `phaser-ce` library on each project.
33+
34+
The `@robotlegsjs/phaser-ce-signalcommandmap` package is compatible with versions between the `>=2.8.1 <3` version range of `phaser-ce` library.
35+
36+
As example, when you would like to use the version `2.8.1` of `phaser-ce` library, you can run:
37+
38+
```bash
39+
npm install [email protected] reflect-metadata --save-prod
40+
```
41+
42+
or
43+
44+
```bash
45+
yarn add [email protected] reflect-metadata
46+
```
47+
3148
Then follow the [installation instructions](https://github.com/RobotlegsJS/RobotlegsJS/blob/master/README.md#installation) of **RobotlegsJS** library to complete the setup of your project.
3249

50+
**Dependencies**
51+
52+
+ [RobotlegsJS](https://github.com/RobotlegsJS/RobotlegsJS)
53+
+ [tslib](https://github.com/Microsoft/tslib)
54+
55+
**Peer Dependencies**
56+
57+
+ [Phaser-CE](https://github.com/photonstorm/phaser-ce)
58+
+ [reflect-metadata](https://github.com/rbuckton/reflect-metadata)
59+
3360
License
3461
---
3562

0 commit comments

Comments
 (0)