We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent a0fb78d commit 50b3ddfCopy full SHA for 50b3ddf
2 files changed
README.md
@@ -20,7 +20,25 @@ by adding `hlclock` to your list of dependencies in `mix.exs`:
20
21
```elixir
22
def deps do
23
- [{:hlclock, "~> 0.1.3"}]
+ [{:hlclock, "~> 1.0"}]
24
end
25
```
26
27
+## Usage
28
+
29
+In order to generate HLCs you'll need an HLClock process:
30
31
+```elixir
32
+{:ok, clock} = HLClock.start_link()
33
+{:ok, ts} = HLClock.send_timestamp(clock)
34
+```
35
36
+You can also supervise clock processes:
37
38
39
+children = [
40
+ {HLClock, name: :my_hlc_server},
41
+]
42
43
44
+`HLClock.start_link/1` accepts all arguments for `GenServer`.
mix.exs
@@ -1,7 +1,7 @@
1
defmodule HLClock.Mixfile do
2
use Mix.Project
3
4
- @version "0.1.7"
+ @version "1.0.0"
5
6
def project do
7
[
0 commit comments