From 4ebd476c12b249731e7c7ecd1bd6401a81d2fbee Mon Sep 17 00:00:00 2001 From: Miguel Palhas Date: Wed, 24 Jun 2020 11:13:41 +0100 Subject: [PATCH] Adding temp readme --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index ab098fe..50d58cb 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ # Fsmx -**TODO: Add description** +A Finite-state machine implementation in Elixir, with opt-in Ecto friendliness ## Installation -If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `fsmx` to your list of dependencies in `mix.exs`: +Add dictator to your list of dependencies in `mix.exs`: ```elixir def deps do @@ -15,7 +14,16 @@ def deps do end ``` -Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) -and published on [HexDocs](https://hexdocs.pm). Once published, the docs can -be found at [https://hexdocs.pm/fsmx](https://hexdocs.pm/fsmx). +## Usage +TODO + +## Ecto support + +TODO + +# About + +`Fsmx` is maintained by [Subvisual](http://subvisual.com). + +[Subvisual logo](https://subvisual.com)