Skip to content

Commit

Permalink
Add READMEs for all versions and update main with version suggestion
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesSkemp committed Jan 22, 2019
1 parent c384360 commit d0a65ba
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ To use one of these templates you can download a copy of, or clone, this reposit

See each individual project for specific requirements and setup instructions.

### Which Version Should I Use?
If you're not sure what version to use, I would recommend starting with Phaser 3.

While not as stable or mature as Phaser 2.x, and there aren't as many tutorials *yet* (but it is getting there), Phaser 3 is where the future is at.

If you're new to JavaScript and/or game development, using Phaser Community Edition is also an option. Phaser 2 tutorials will generally work fine, requiring minor changes, if any.

### Phaser 3
Phaser 3 (previously named Lazer) is the latest official version of Phaser.

Expand Down
2 changes: 2 additions & 0 deletions v2-ce/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Phaser 2 Community Edition (CE)
As of this writing, Phaser Community Edition (CE) is the active branch of Phaser v2. New features and bug fixes are being made to this code, so it's recommended to use this over the last official release of Phaser 2.
7 changes: 7 additions & 0 deletions v2-official/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Phaser 2.6.2
Version 2.6.2 was the last official/non-community edition of Phaser. While this version can be used, it is no longer actively supported.

It is generally recommended to use either [the Community Edition of Phaser 2][phaser-2-ce], or [Phaser 3][phaser-3], which is a complete rewrite of the API.

[phaser-2-ce]: ../v2-ce
[phaser-3]: ../v3
4 changes: 4 additions & 0 deletions v3/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Phaser 3
Phaser 3 (previously named Lazer) is the latest official version of Phaser.

TypeScript definitions are manually updated, from https://github.com/photonstorm/phaser3-docs/tree/master/typescript, as they are not yet part of the npm process. If copying one of these templates you must also copy the Phaser TypeScript defintions and either keep it in the same relative location, or update the project accordingly.

0 comments on commit d0a65ba

Please sign in to comment.