documentation index

docs/README.md

@@ -0,0 +1,10 @@
+# `Crem` docs
+
+`Crem` is a library to create, compose, run and render state machines.
+
+Usually the library should be used following these four steps:
+
+- [create several small machines](./how-to-create-a-machine.md)
+- [compose the machines together to create more complex machines](./how-to-compose-machines.md)
+- [execute your machine](./how-to-run-a-machine.md)
+- [render the topology and the flow of your machine](./how-to-render-a-machine.md)