chore(project): add README

This commit is contained in:
Nico Rehwaldt 2014-05-07 09:55:06 +02:00
parent 7540186f6e
commit b2011ce4fe
1 changed files with 23 additions and 0 deletions

23
README.md Normal file
View File

@ -0,0 +1,23 @@
# bpmn-js - BPMN 2.0 diagrams for the web
bpmn-js is the BPMN 2.0 diagram modeling and rendering toolkit that powers [bpmn.io](http://bpmn.io).
> bpmn-js is in an alpha stage, expect documentation to be missing and examples to be broken.
## Resources
* [Demo](http://demo.bpmn.io)
* [Issues](https://github.com/bpmn-io/bpmn-js/issues)
* [Examples](https://github.com/bpmn-io/bpmn-js/tree/master/example)
## Building the Project
As long as the project is in alpha stage, you must make sure you setup the whole development environment, including a number of [project dependencies](https://github.com/bpmn-io) according to [our development setup](https://github.com/bpmn-io/bpmn-js/blob/master/docs/project/SETUP.md).
## License
Use under the terms of the [bpmn-js license](http://bpmn.io/license).