Skip to content

Commit 0f4a083

Browse files
author
Lanny McNie
committed
Updated README. Contains fixed links to docs, as well as other information that had not been updated in some time.
1 parent 5ffe3ec commit 0f4a083

1 file changed

Lines changed: 30 additions & 8 deletions

File tree

README.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# EaselJS
22

3-
EaselJS is a library for building high-performance interactive 2D content in HTML5. It provides a feature-rich display list to allow you to manipulate and animate graphics. It also provides a robust interactive model for mouse and touch interactions.
3+
EaselJS is a library for building high-performance interactive 2D content in HTML5. It provides a feature-rich display
4+
list to allow you to manipulate and animate graphics. It also provides a robust interactive model for mouse and touch
5+
interactions.
46

5-
It is excellent for building games, generative art, ads, data visualization, and other highly graphical experiences. It works well alone, or with the rest of the [CreateJS](http://createjs.com/) suite: [SoundJS](http://createjs.com/SoundJS), [PreloadJS](http://createjs.com/PreloadJS), and [TweenJS](http://createjs.com/TweenJS).
7+
It is excellent for building games, generative art, ads, data visualization, and other highly graphical experiences. It
8+
works well alone, or with the rest of the [CreateJS](http://createjs.com/) suite: [SoundJS](http://createjs.com/soundjs),
9+
[PreloadJS](http://createjs.com/preloadjs), and [TweenJS](http://createjs.com/tweenjs).
610

711
It has no external dependencies, and should be compatible with virtually any framework you enjoy using.
812

@@ -40,26 +44,31 @@ createjs.Ticker.on("tick", stage);
4044

4145
## Support and Resources
4246
* Find examples and more information at the [EaselJS web site](http://easeljs.com/).
43-
* Read the [documentation](http://createjs.com/Docs/EaselJS).
47+
* Read the [documentation](http://createjs.com/docs/easeljs).
4448
* Discuss, share projects, and interact with other users on [reddit](http://www.reddit.com/r/createjs/).
4549
* Ask technical questions on [Stack Overflow](http://stackoverflow.com/questions/tagged/easeljs).
4650
* File verified bugs or formal feature requests using Issues on [GitHub](https://github.com/createjs/EaselJS/issues).
4751
* There is a [Google Group](http://groups.google.com/group/createjs-discussion) for discussions and support.
48-
* Have a look at the included [examples](https://github.com/CreateJS/EaselJS/tree/master/examples) and [API documentation](http://createjs.com/Docs/EaselJS/) for more in-depth information.
52+
* Have a look at the included [examples](https://github.com/CreateJS/EaselJS/tree/master/examples) and
53+
[API documentation](http://createjs.com/docs/easeljs/) for more in-depth information.
4954

5055
It was built by [gskinner.com](http://www.gskinner.com), and is released for free under the MIT license, which means you
51-
can use it for almost any purpose (including commercial projects). We appreciate credit where possible, but it is not a requirement.
56+
can use it for almost any purpose (including commercial projects). We appreciate credit where possible, but it is not a
57+
requirement.
5258

5359

5460
## Classes
5561

56-
The API is inspired in part by Flash's display list, and should be easy to pick up for both JS and AS3 developers. Check out the [docs](http://createjs.com/Docs/EaselJS/) for more information.
62+
The API is inspired in part by Flash's display list, and should be easy to pick up for both JS and AS3 developers. Check
63+
out the [docs](http://createjs.com/docs/easeljs/) for more information.
5764

5865
**DisplayObject**
59-
Abstract base class for all display elements in EaselJS. Exposes all of the display properties (ex. x, y, rotation, scaleX, scaleY, skewX, skewY, alpha, shadow, etc) that are common to all display objects.
66+
Abstract base class for all display elements in EaselJS. Exposes all of the display properties (ex. x, y, rotation,
67+
scaleX, scaleY, skewX, skewY, alpha, shadow, etc) that are common to all display objects.
6068

6169
**Stage**
62-
The root level display container for display elements. Each time tick() is called on Stage, it will update and render the display list to its associated canvas.
70+
The root level display container for display elements. Each time tick() is called on Stage, it will update and render
71+
the display list to its associated canvas.
6372

6473
**Container**
6574
A nestable display container, which lets you aggregate display objects and manipulate them as a group.
@@ -79,6 +88,9 @@ Provides an easy to use API for drawing vector data. Can be used with Shape, or
7988
**Text**
8089
Renders a single line of text to the stage.
8190

91+
**BitmapText**
92+
Renders text using a SpriteSheet of letter.
93+
8294
**DOMElement**
8395
An experimental display object that allows you to manage an HTML element as a part of the display list.
8496

@@ -115,3 +127,13 @@ Represents a rectangle as defined by the points (x, y) and (x+width, y+height).
115127

116128
**Point**
117129
Represents a point on a 2 dimensional x / y coordinate system.
130+
131+
A WebGL implementation currently exists, but is limited.
132+
133+
**SpriteContainer**
134+
A container that accepts a SpriteSheet, and uses a WebGL stage (SpriteStage) for WebGL-accelerated content.
135+
136+
**SpriteStage**
137+
A Stage class that uses a WebGL context. Currently, can only have children that are SpriteContainers.
138+
139+
A new WebGL implementation is in the works, which removes these limitations.

0 commit comments

Comments
 (0)