Skip to content

Commit 1764418

Browse files
committed
Add Docs
1 parent 2d8ffd6 commit 1764418

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,21 @@ of dependencies in `mix.exs`:
1616
```elixir
1717
def deps do
1818
[
19-
{:quantum_storage_persistent_ets, "~> 0.1.0"}
19+
{:quantum_storage_persistent_ets, "~> 1.0-rc"}
2020
]
2121
end
2222
```
2323

24-
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
25-
and published on [HexDocs](https://hexdocs.pm). The docs can be found at
26-
[https://hexdocs.pm/quantum_storage_persistent_ets](https://hexdocs.pm/quantum_storage_persistent_ets).
24+
To enable the storage adpater, add this to your `config.exs`:
25+
26+
```elixir
27+
use Mix.Config
28+
29+
config :quantum_test, QuantumTest.Scheduler,
30+
storage: QuantumStoragePersistentEts%
31+
```
32+
33+
The docs can be found at [https://hexdocs.pm/quantum_storage_persistent_ets](https://hexdocs.pm/quantum_storage_persistent_ets).
2734

2835
## Contribution
2936

0 commit comments

Comments
 (0)