Skip to content

Commit 4bb1b15

Browse files
authored
More Download/Usage Options
1 parent 0cc3a46 commit 4bb1b15

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,14 @@
11
<h1>ZephyrJS</h1>
22
<p><b>Expands PixiJS for easy game development!</b></p>
3-
43
<h2>Tell Me Why</h2>
5-
64
<p>PixiJS on its own is very powerful, but a lot of work is needed to make it work for web-based games. PhaserIO is exclusively used to make games, and not all of the functionality is easily translatable back to Pixi. ZephyrJS directly ADDS to Pixi instead of wrapping it, letting you use the full functionality of Pixi so that the work is translatable.</p>
7-
85
<h2><a href="https://raw.githubusercontent.com/OttCS/ZephyrJS/main/dev/zepyhr.js">Download</a> & Get Started!</h2>
9-
10-
<p>Just by downloading zephyr.js (use the link above to get to the file) and including the following lines:</p>
11-
12-
<code>&lt;script src="https&#58;//pixijs.download/release/pixi.js"&gt;&lt;/script&gt;</code>
13-
<br/>
14-
<code>&lt;script src="../path/to/zephyr.js"&gt;&lt;/script&gt;</code>
15-
16-
<p>all of the functionality of PixiJS and Zephyr have been added!</p>
17-
18-
<p>For more on the functionality, check out the <a href="https://github.com/OttCS/ZephyrJS/tree/main/dev">documentation</a>!<p>
6+
<p>Just by including the following lines (ORDER MATTERS):</p>
7+
<p><code>&lt;script src="https&#58;//pixijs.download/release/pixi.js"&gt;&lt;/script&gt;</code><br/><code>&lt;script src="https://ottcs.github.io/ZephyrJS/dev/zepyhr.js"&gt;&lt;/script&gt;</code></p>
8+
<p>all of the functionality of PixiJS and Zephyr have been added, through Content Delivery Networks.</p>
9+
<p><b>NOTE: </b>If you're looking to release a stable version of your game, or if development is taking place over a span of time, using the CDNs aren't the best option (as specs and functionality can change). Download stable versions of both Zephyr and Pixi using the following links:</p>
10+
<p><a href="https://raw.githubusercontent.com/OttCS/ZephyrJS/main/dev/zepyhr.js">ZephyrJS Download</a> | <a href="https://github.com/pixijs/pixijs/releases">PixiJS Download</a></p>
11+
<p>Then include the script tags above with the path to the files as the src attribute.</p>
12+
<h2>More</h2>
13+
<p>Check out the <a href="https://github.com/OttCS/ZephyrJS/tree/main/dev">documentation</a>!<p>
14+
<p>Also, I'd love it if you have an idea for some functionality! Start an issue report or discussion, or make a WELL DOCUMENTED pull request and I can include you in further development!</p>

0 commit comments

Comments
 (0)