Tim Buchwaldt 7 lat temu
rodzic
commit
8c669c62c2
1 zmienionych plików z 6 dodań i 4 usunięć
  1. 6 4
      README.md

+ 6 - 4
README.md

@@ -1,16 +1,18 @@
 # GenReset
 
-**TODO: Add description**
+Bored of resetting GenServers manually during testing? I was, so I built this.
+
+
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `gen_reset` to your list of dependencies in `mix.exs`:
+Add gen_reset to your dependencies. Then add `use GenReset` after your `use GenServer` line.
+A tracking server is automatically started that allows you to reset all servers at the same time: `GenServer.Tracker.reset()` - you can put this into your `setup` block.
 
 ```elixir
 def deps do
   [
-    {:gen_reset, "~> 0.1.0"}
+    {:gen_reset, git: "https://git.chaos.koeln/tim/gen_reset.git"}
   ]
 end
 ```