Skip to content

Commit 50b3ddf

Browse files
committed
Bump version
1 parent a0fb78d commit 50b3ddf

2 files changed

Lines changed: 20 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,25 @@ by adding `hlclock` to your list of dependencies in `mix.exs`:
2020

2121
```elixir
2222
def deps do
23-
[{:hlclock, "~> 0.1.3"}]
23+
[{:hlclock, "~> 1.0"}]
2424
end
2525
```
2626

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+
```elixir
39+
children = [
40+
{HLClock, name: :my_hlc_server},
41+
]
42+
```
43+
44+
`HLClock.start_link/1` accepts all arguments for `GenServer`.

mix.exs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
defmodule HLClock.Mixfile do
22
use Mix.Project
33

4-
@version "0.1.7"
4+
@version "1.0.0"
55

66
def project do
77
[

0 commit comments

Comments
 (0)