diff --git a/README.md b/README.md index 5c18489..1681df1 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,10 @@ Pixi Renderer ============= -## Rewrite TODO - -See: https://github.com/GoodBoyDigital/pixi.js/issues/1296 - - -### Phase 1 Folder Browserify Status - -- [x] `index` -- [x] `display/` -- [x] `extras/` -- [x] `filters/` -- [x] `geom/` (move to `math/`) -- [x] `loaders/` -- [x] `primitives/` -- [x] `renderers/` -- [x] `text/` -- [x] `textures/` -- [x] `utils/` -- [x] `interactions/` (move Interaction* to here) - - -#### *** IMPORTANT - V2 API CHANGES *** #### - -A heads up for anyone updating their version of pixi.js to version 2, as we have changed a couple of bits that you need to be aware of. Fortunately, there are only two changes, and both are small. - -1: Creating a renderer now accepts an options parameter that you can add specific settings to: -``` -// an optional object that contains the settings for the renderer -var options = { - view:myCanvas, - resolution:1 -}; - -var renderer = new PIXI.WebGLRenderer(800, 600, options) -``` - -2: A ```PIXI.RenderTexture``` now accepts a ```PIXI.Matrix``` as its second parameter instead of a point. This gives you much more flexibility: - -``` myRenderTexture.render(myDisplayObject, myMatrix) ``` - -Check out the docs for more info! - - ![pixi.js logo](http://www.goodboydigital.com/pixijs/logo_small.png) [](http://www.pixijs.com/projects) + #### JavaScript 2D Renderer #### The aim of this project is to provide a fast lightweight 2D library that works @@ -102,17 +60,6 @@ [Pixi.js forum]() - -### Road Map ### - -* Create a Typescript definition file for Pixi.js -* Implement Flash animation to pixi -* Update Loader so that it support XHR2 if it is available -* Improve the Documentation of the Project -* Create an Asset Loader Tutorial -* Create a MovieClip Tutorial -* Create a small game Tutorial - ### Contribute ### Want to be part of the pixi.js project? Great! All are welcome! We will get there quicker together :) @@ -151,11 +98,14 @@ ``` $> npm run docs ``` + There is also a gulp task to generate them if you want to: ``` $> gulp docs ``` -The documentation uses [DocStrap](https://github.com/terryweiss/docstrap) and the jsdoc format, the configuration file can be found at [gulp/utils/jsdoc.conf.json](https://github.com/GoodBoyDigital/pixi.js/blob/dev/gulp/util/jsdoc.conf.json) + +The documentation uses [DocStrap](https://github.com/terryweiss/docstrap) and the jsdoc format, the configuration +file can be found at [gulp/utils/jsdoc.conf.json](https://github.com/GoodBoyDigital/pixi.js/blob/dev/gulp/util/jsdoc.conf.json) ### Current features ### @@ -185,7 +135,7 @@ document.body.appendChild(renderer.view); - var stage = new PIXI.Stage(); + var stage = new PIXI.Container(); var bunnyTexture = PIXI.Texture.fromImage("bunny.png"); var bunny = new PIXI.Sprite(bunnyTexture);