lsm/konva
1
0
Fork 0
mirror of https://github.com/konvajs/konva.git synced 2025-06-28 05:36:38 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

update name

Browse Source
This commit is contained in:
lavrton 2015-01-27 12:34:30 +07:00
parent 3581919cf4
commit c4e2a2997d
1 changed files with 16 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,8 +1,8 @@
#KineticJS
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.
Konva 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.
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/lavrton/KineticJS?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/konvajs/konva?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![npm version](https://badge.fury.io/js/kinetic.svg)](http://badge.fury.io/js/kinetic) [![bower version](https://badge.fury.io/bo/kinetic.svg)](http://badge.fury.io/bo/kinetic)
[![Build Status](https://travis-ci.org/lavrton/KineticJS.png)](https://travis-ci.org/lavrton/KineticJS) [![Code Climate](https://codeclimate.com/github/lavrton/KineticJS/badges/gpa.svg)](https://codeclimate.com/github/lavrton/KineticJS)
@ -11,15 +11,15 @@ You can draw things onto the stage, add event listeners to them, move them, scal
This repository began as a GitHub fork of [ericdrowell/KineticJS](https://github.com/ericdrowell/KineticJS).
* **Visit:** The [GitHub page](http://lavrton.github.io/KineticJS/) and follow on [Twitter](https://twitter.com/lavrton)
* **Discover:** [Tutorials](http://lavrton.github.io/KineticJS/Getting_Started.html), [API Documentation](http://lavrton.github.io/KineticJS/api/Kinetic.html)
* **Help:** [StackOverflow](http://stackoverflow.com/questions/tagged/kineticjs)
* **Visit:** The [Home Page](http://konvajs.github.io/) and follow on [Twitter](https://twitter.com/lavrton)
* **Discover:** [Tutorials](http://konvajs.github.io/docs), [API Documentation](http://konvajs.github.io/docs)
* **Help:** [StackOverflow](http://stackoverflow.com/questions/tagged/konvajs)
#Installation
* `bower install kinetic`
* `npm install kinetic` - for Browserify. For nodejs you have to install some [dependencies](#nodejs)
* CDN: [https://cdnjs.com/libraries/kineticjs](https://cdnjs.com/libraries/kineticjs)
* `bower install konva`
* `npm install konva` - for Browserify. For nodejs you have to install some [dependencies](#nodejs)
* CDN: [https://cdnjs.com/libraries/konva](https://cdnjs.com/libraries/konva)
###NodeJS
@ -27,13 +27,13 @@ We are using [node-canvas](https://github.com/LearnBoost/node-canvas) to create
1. Install node-canvas [https://github.com/LearnBoost/node-canvas/wiki/_pages](https://github.com/LearnBoost/node-canvas/wiki/_pages)
2. `npm install jsdom`
3. `npm install kinetic`
3. `npm install konva`
See file `resources/nodejs-demo.js` for example.
#Change log
See [CHANGELOG.md](https://github.com/lavrton/KineticJS/blob/master/CHANGELOG.md).
See [CHANGELOG.md](https://github.com/konvajs/konva/blob/master/CHANGELOG.md).
#Dev environment
@ -41,7 +41,7 @@ Before doing all dev stuff make sure you have node installed. After that, run `n
Run `grunt --help` to see all build options.
##Building the KineticJS Framework
##Building the Konva Framework
To build a development version of the framework, run `grunt dev`. To run a full build, which also produces the minified version and the individually minified modules for the custom build, run `grunt full`. You can also run `grunt beta` to generate a beta version.
@ -49,12 +49,13 @@ If you add a file in the src directory, be sure to add the filename to the sourc
##Testing
KineticJS uses Mocha for testing.
Konva uses Mocha for testing.
* If you need run test only one time run `grunt test`.
* While developing it is easy to use `grunt server` with watch task. Just run it and go to [http://localhost:8080/test/runner.html](http://localhost:8080/test/runner.html). After src file change kinetic-dev.js will be automatically created, so you just need refresh test the page.
KineticJS is covered with hundreds of tests and well over a thousand assertions. KineticJS uses TDD (test driven development) which means that every new feature or bug fix is accompanied with at least one new test.
Konva is covered with hundreds of tests and well over a thousand assertions.
Konva uses TDD (test driven development) which means that every new feature or bug fix is accompanied with at least one new test.
##Generate documentation
@ -62,4 +63,5 @@ Run `grunt docs` which will build the documentation files and place them in the
#Pull Requests
I'd be happy to review any pull requests that may better the KineticJS project, in particular if you have a bug fix, enhancement, or a new shape (see `src/shapes` for examples). Before doing so, please first make sure that all of the tests pass (`grunt test`).
I'd be happy to review any pull requests that may better the Konva project,
in particular if you have a bug fix, enhancement, or a new shape (see `src/shapes` for examples). Before doing so, please first make sure that all of the tests pass (`grunt test`).