From b2011ce4fe68d5ecf2190ee552f22de25883d20e Mon Sep 17 00:00:00 2001 From: Nico Rehwaldt Date: Wed, 7 May 2014 09:55:06 +0200 Subject: [PATCH] chore(project): add README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..f12dccca --- /dev/null +++ b/README.md @@ -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). \ No newline at end of file