Update docs

norbajunior · Apr 2, 2021 · 52618fd · 52618fd
1 parent ec291f4
commit 52618fd
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/lib/machinist.ex b/lib/machinist.ex
@@ -2,6 +2,20 @@ defmodule Machinist do
  @moduledoc """
  `Machinist` is a small library that allows you to implement finite state machines with Elixir in a simple way. It provides a simple DSL to write combinations of transitions based on events.
 
+ ## Installation
+
+ You can install `machinist` by adding it to your list of dependencies in `mix.exs`:
+
+ ```elixir
+ def deps do
+ [
+ {:machinist, "~> 0.2.0"}
+ ]
+ end
+ ```
+
+ ## Usage
+
  A good example is how we would implement the behaviour of a door. With `machinist` would be this way:
 
  ```elixir