|
1 | 1 | # Petrinet |
2 | 2 |
|
3 | | -This framework allows to create, vizualize and execute Petrinets. |
| 3 | +[](https://travis-ci.org/florianv/petrinet) |
| 4 | +[](https://insight.sensiolabs.com/projects/4a15ed6f-09d8-4678-bd49-629b4c1c1251) |
| 5 | +[](https://packagist.org/packages/florianv/petrinet) |
| 6 | +[](https://packagist.org/packages/florianv/petrinet) |
4 | 7 |
|
5 | | -[](https://travis-ci.org/florianv/petrinet) |
6 | | -[](https://coveralls.io/r/florianv/petrinet) |
7 | | -[](https://insight.sensiolabs.com/projects/16f7c4d1-7448-463d-b68a-61429a8202c3) |
8 | | -[](https://packagist.org/packages/florianv/petrinet) |
9 | | -[](https://packagist.org/packages/florianv/petrinet) |
10 | | -[](https://packagist.org/packages/florianv/petrinet) |
11 | | -[](https://packagist.org/packages/florianv/petrinet) |
12 | | - |
13 | | -## Requirements |
14 | | - |
15 | | -Petrinet requires PHP 5.3.3+. |
| 8 | +This framework allows to build, vizualize and execute [Petrinets](http://en.wikipedia.org/wiki/Petri_net) |
| 9 | +which can be used to build workflow engines. It provides the core domain model of basic Petrinets that can be persisted |
| 10 | +using your favorite ORM as well as services to manage its execution. |
16 | 11 |
|
17 | 12 | ## Installation |
18 | 13 |
|
19 | | -Petrinet is installable via [Composer](http://getcomposer.org/). |
| 14 | +The recommended way to install Petrinet is via [Composer](https://getcomposer.org). |
| 15 | + |
| 16 | +Add this line to your `composer.json` file: |
20 | 17 |
|
21 | 18 | ```json |
22 | 19 | { |
23 | 20 | "require": { |
24 | | - "florianv/petrinet": "~1.0" |
| 21 | + "florianv/petrinet": "~2.0" |
25 | 22 | } |
26 | 23 | } |
27 | 24 | ``` |
28 | 25 |
|
29 | | -## Documentation |
| 26 | +Tell Composer to update the dependency by running: |
30 | 27 |
|
31 | | -The documentation is available [here](https://github.com/florianv/petrinet/blob/master/docs/documentation.md). |
| 28 | +```bash |
| 29 | +$ php composer.phar update florianv/petrinet |
| 30 | +``` |
| 31 | + |
| 32 | +## Documentation |
32 | 33 |
|
33 | | -## Contributing |
| 34 | +[Read the documentation for master](https://github.com/florianv/petrinet/blob/master/docs/documentation.md) |
34 | 35 |
|
35 | | -The contribution guide is available [here](https://github.com/florianv/petrinet/blob/master/CONTRIBUTING.md). |
| 36 | +[Read the documentation for the 1.0 version](https://github.com/florianv/petrinet/blob/1.0/docs/documentation.md) |
36 | 37 |
|
37 | 38 | ## License |
38 | 39 |
|
39 | | -[MIT](https://github.com/florianv/petrinet/blob/master/LICENSE). |
| 40 | +[MIT](https://github.com/florianv/petrinet/blob/master/LICENSE) |
0 commit comments