Skip to content

Commit 8c996ca

Browse files
committed
Added link to TypeScript defs
1 parent 89c963c commit 8c996ca

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,19 @@ or the minified version:
105105
<script src="//cdn.jsdelivr.net/npm/phaser@3.3.0/dist/phaser.min.js"></script>
106106
```
107107

108+
### API Documentation
109+
110+
1. Go to https://photonstorm.github.io/phaser3-docs/index.html to read the docs online.
111+
2. Checkout the [phaser3-docs](https://github.com/photonstorm/phaser3-docs) repository and then read the documentation by pointing your browser to the local `docs/` folder.
112+
113+
The documentation for Phaser 3 is an on-going project. Please help us by searching the Phaser code for any instance of the string `[description]` and then replacing it with some documentation.
114+
115+
### TypeScript Definitions
116+
117+
[TypeScript Definitions](https://github.com/photonstorm/phaser3-docs/tree/master/typescript) are now available.
118+
119+
They are automatically generated from the jsdoc comments in the Phaser source code. If you wish to help refine them then you must edit the Phaser jsdoc blocks directly. You can find more details, including the source to the conversion tool we wrote in the Docs repo.
120+
108121
### License
109122

110123
Phaser is released under the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)