Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
shrink0r committed Dec 9, 2016
1 parent 107580b commit 96ea98a
Showing 1 changed file with 3 additions and 7 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,12 @@
## Purpose

`Workflux` is a [Finite State Machine(FSM)](http://en.wikipedia.org/wiki/Finite-state_machine) for php.
It's supposed to be useful for implementing all kinds of FSM suiting scenarios like e.g. workflows or matching.
Here are two reads on the topic, dealing with why/where you might want to use a FSM.

Good reads on the topic:

* [Why developers should be force-fed state machines](http://www.shopify.com/technology/3383012-why-developers-should-be-force-fed-state-machines)
* [Why Developers Never Use State Machines](http://www.skorks.com/2011/09/why-developers-never-use-state-machines/)

Below is an example of a state machine instance rendered by the library's DotGraphRenderer + [Graphviz](http://www.graphviz.org).

![Screenshot of a rendered example state machine](https://raw.githubusercontent.com/shrink0r/workflux/master/docs/state_machine.png)

## Requirements and installation

- PHP 7.0+
Expand All @@ -49,7 +45,7 @@ tbd.

## Community

None, but you may join the freenode IRC [`#honeybee`](irc://irc.freenode.org/honeybee) channel anytime. :-)
None, but you may join the freenode IRC [`#honeybee`](irc://irc.freenode.org/honeybee) channel or https://gitter.im/honeybee/Lobby anytime. :-)

## Contributors

Expand Down

0 comments on commit 96ea98a

Please sign in to comment.