sartography
/
bpmn-js
mirror of https://github.com/sartography/bpmn-js.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(README): add links to diagram-js + bpmn-moddle

This commit is contained in:
Nico Rehwaldt 2014-06-19 08:11:13 +02:00
parent dc3fca67b1
commit 134c65bdd9
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -5,6 +5,7 @@
> the project is still in an early stage. Documentation may be missing and examples may be broken. > the project is still in an early stage. Documentation may be missing and examples may be broken.
## Usage ## Usage
Get the library via [npm](http://npmjs.org) or [bower](http://bower.io) and use it in your web applications to display [BPMN 2.0 diagrams](http://www.bpmn.org/). Get the library via [npm](http://npmjs.org) or [bower](http://bower.io) and use it in your web applications to display [BPMN 2.0 diagrams](http://www.bpmn.org/).
@ -58,6 +59,14 @@ Checkout an [example project](https://github.com/bpmn-io/bpmn-js-examples/tree/m
* [Examples](https://github.com/bpmn-io/bpmn-js-examples) * [Examples](https://github.com/bpmn-io/bpmn-js-examples)
## Tools
bpmn-js builds on top of a few additional powerful tools
* [bpmn-moddle](https://github.com/bpmn-io/bpmn-moddle): Read / write support for BPMN 2.0 XML in the browsers
* [diagram-js](https://github.com/bpmn-io/diagram-js): Diagram rendering and editing toolkit
## Building the Project ## 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). 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).
@ -65,4 +74,4 @@ As long as the project is in alpha stage, you must make sure you setup the whole
## License ## License
Use under the terms of the [bpmn-js license](http://bpmn.io/license). Use under the terms of the [bpmn-js license](http://bpmn.io/license).