lsm/konva
1
0
Fork 0
mirror of https://github.com/konvajs/konva.git synced 2025-09-18 18:27:58 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
lavrton
2015-01-09 19:51:36 +07:00
parent 07622b64ae
commit 4e66cf3d3b
2 changed files with 35 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -1,3 +1,13 @@
#KineticJS
[![Build Status](https://travis-ci.org/lavrton/KineticJS.png)](https://travis-ci.org/lavrton/KineticJS) [![npm version](https://badge.fury.io/js/kinetic.svg)](http://badge.fury.io/js/kinetic)
Greetings fellow webonauts! KineticJS is an HTML5 Canvas JavaScript framework that enables high performance animations, transitions, node nesting, layering, filtering, caching, event handling for desktop and mobile applications, and much more.
You can draw things onto the stage, add event listeners to them, move them, scale them, and rotate them independently from other shapes to support high performance animations, even if your application uses thousands of shapes. Served hot with a side of awesomeness.
Go to [http://lavrton.github.io/KineticJS/](http://lavrton.github.io/KineticJS/) for tutorial and documentation.
#Installation
* `bower install kineticjs`
@@ -5,8 +15,6 @@
###NodeJS
Support of NodeJS is experimental.
We are using [node-canvas](https://github.com/LearnBoost/node-canvas) to create canvas element.
1. Install node-canvas [https://github.com/LearnBoost/node-canvas/wiki/_pages](https://github.com/LearnBoost/node-canvas/wiki/_pages)
@@ -15,6 +23,10 @@ We are using [node-canvas](https://github.com/LearnBoost/node-canvas) to create
See file `nodejs-demo.js` for example.
#Change log
See [CHANGELOG.md](https://github.com/lavrton/KineticJS/blob/master/CHANGELOG.md).
#Dev environment
Before doing all dev stuff make sure you have node installed. After that, run `npm install --dev` in the main directory to install the node module dependencies.
@@ -29,8 +41,6 @@ If you add a file in the src directory, be sure to add the filename to the sourc
##Testing
[![Build Status](https://travis-ci.org/lavrton/KineticJS.png)](https://travis-ci.org/lavrton/KineticJS)
KineticJS uses Mocha for testing.
* If you need run test only one time run `grunt test`.