Skip to content

Commit

Permalink
📝 Update documentation with small grammar tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
EwanRoberts committed Apr 23, 2019
1 parent f72d9b1 commit c375eea
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Dev dependencies:
To quickly get going, check out [this example](https://tarvk.github.io/pixi-shadows/build/demos/basic/):

```js
// Import everything, can of course just use <script> tags on your page as well.
// Import everything, you can of course just use <script> tags on your page as well.
import "pixi.js";
import "pixi-layers";
import "pixi-shadows";
Expand All @@ -54,7 +54,7 @@ document.body.appendChild(app.view);
// Create a world container
var world = PIXI.shadows.init(app, world);

// A function to combine different assets if your world object, but give them a common transform by using pixi-layers
// A function to combine different assets of your world object, but give them a common transform by using pixi-layers
// It is of course recommended to create a custom class for this, but this demo just shows the minimal steps required
function createShadowSprite(texture, shadowTexture) {
var container = new PIXI.Container(); // This represents your final 'sprite'
Expand Down
4 changes: 2 additions & 2 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h2 id="dependencies"><a class="header-link" href="#dependencies"></a>Dependenci
</ul>
<h2 id="usage"><a class="header-link" href="#usage"></a>Usage</h2>
<p>Too quickly get going, check out <a href="https://tarvk.github.io/pixi-shadows/build/demos/basic/">this example</a>:</p>
<pre class="hljs"><code><span class="hljs-comment">// Import everything, can of course just use &lt;script&gt; tags on your page as well.</span>
<pre class="hljs"><code><span class="hljs-comment">// Import everything, you can of course just use &lt;script&gt; tags on your page as well.</span>
<span class="hljs-keyword">import</span> <span class="hljs-string">'pixi.js'</span>;
<span class="hljs-keyword">import</span> <span class="hljs-string">'pixi-layers'</span>;
<span class="hljs-keyword">import</span> <span class="hljs-string">'pixi-shadows'</span>;
Expand All @@ -49,7 +49,7 @@ <h2 id="usage"><a class="header-link" href="#usage"></a>Usage</h2>
<span class="hljs-comment">// Create a world container</span>
<span class="hljs-keyword">var</span> world = PIXI.shadows.init(app, world);

<span class="hljs-comment">// A function to combine different assets if your world object, but give them a common transform by using pixi-layers</span>
<span class="hljs-comment">// A function to combine different assets of your world object, but give them a common transform by using pixi-layers</span>
<span class="hljs-comment">// It is of course recommended to create a custom class for this, but this demo just shows the minimal steps required</span>
<span class="hljs-function"><span class="hljs-keyword">function</span> <span class="hljs-title">createShadowSprite</span>(<span class="hljs-params">texture, shadowTexture</span>) </span>{
<span class="hljs-keyword">var</span> container = <span class="hljs-keyword">new</span> PIXI.Container(); <span class="hljs-comment">// This represents your final 'sprite'</span>
Expand Down
4 changes: 2 additions & 2 deletions src/demos/advanced/index.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Import everything, can of course just use <script> tags on your page as well.
// Import everything, you can of course just use <script> tags on your page as well.
import "pixi.js";
import "pixi-layers";
import "../../shadows"; // This plugin, I use a relative path, but you would use 'pixi-shadows' from npm
Expand Down Expand Up @@ -26,7 +26,7 @@ document.body.appendChild(app.view);
var world = PIXI.shadows.init(app);
PIXI.shadows.filter.useShadowCasterAsOverlay = false; // Allows us to customise the overlays

// A function to combine different assets if your world object, but give them a common transform by using pixi-layers
// A function to combine different assets of your world object, but give them a common transform by using pixi-layers
// It is of course recommended to create a custom class for this, but this demo just shows the minimal steps required
function createShadowSprite(texture, shadowTexture, shadowOverlayTexture) {
var container = new PIXI.Container(); // This represents your final 'sprite'
Expand Down
4 changes: 2 additions & 2 deletions src/demos/basic/index.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Import everything, can of course just use <script> tags on your page as well.
// Import everything, you can of course just use <script> tags on your page as well.
import "pixi.js";
import "pixi-layers";
import "../../shadows"; // This plugin, I use a relative path, but you would use 'pixi-shadows' from npm
Expand All @@ -14,7 +14,7 @@ document.body.appendChild(app.view);
// Create a world container
var world = PIXI.shadows.init(app, world);

// A function to combine different assets if your world object, but give them a common transform by using pixi-layers
// A function to combine different assets of your world object, but give them a common transform by using pixi-layers
// It is of course recommended to create a custom class for this, but this demo just shows the minimal steps required
function createShadowSprite(texture, shadowTexture) {
var container = new PIXI.Container(); // This represents your final 'sprite'
Expand Down
4 changes: 2 additions & 2 deletions src/demos/pixi-lights/index.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Import everything, can of course just use <script> tags on your page as well.
// Import everything, you can of course just use <script> tags on your page as well.
import "pixi.js";
import "pixi-layers";
import "../../shadows"; // This plugin, I use a relative path, but you would use 'pixi-shadows' from npm
Expand All @@ -18,7 +18,7 @@ document.body.appendChild(app.view);
// Initialise the shadows plugin
var world = PIXI.shadows.init(app, world);

// A function to combine different assets if your world object, but give them a common transform by using pixi-layers
// A function to combine different assets of your world object, but give them a common transform by using pixi-layers
// It is of course recommended to create a custom class for this, but this demo just shows the minimal steps required
function create3DSprite(diffuseTex, normalTex, shadowTexture) {
var container = new PIXI.Container(); // This represents your final 'sprite'
Expand Down
4 changes: 2 additions & 2 deletions src/demos/system/index.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Import everything, can of course just use <script> tags on your page as well.
// Import everything, you can of course just use <script> tags on your page as well.
import "pixi.js";
import "pixi-layers";
import "../../shadows"; // This plugin, I use a relative path, but you would use 'pixi-shadows' from npm
Expand All @@ -25,7 +25,7 @@ document.body.appendChild(app.view);
var world = PIXI.shadows.init(app);
PIXI.shadows.filter.useShadowCasterAsOverlay = false; // Allows us to customise the overlays

// A function to combine different assets if your world object, but give them a common transform by using pixi-layers
// A function to combine different assets of your world object, but give them a common transform by using pixi-layers
// It is of course recommended to create a custom class for this, but this demo just shows the minimal steps required
function createShadowSprite(texture, shadowTexture, shadowOverlayTexture) {
var container = new PIXI.Container(); // This represents your final 'sprite'
Expand Down

0 comments on commit c375eea

Please sign in to comment.