Skip to content

Commit 26bfc7b

Browse files
committed
Improve readme to include reference to caching
1 parent 9a3d8f7 commit 26bfc7b

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.markdown

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,14 @@ methods are provided as specified within the RFC.
1616

1717
Requires `Erlang >= R16B01`
1818

19-
If you use the functions `uuid:new/1`, `uuid:new/2` or `uuid:get_v4_urandom/0`
20-
in an Erlang process, you must have called the function `quickrand:seed/0`
21-
first (within the same Erlang process).
19+
Usage
20+
-----
21+
22+
For certain methods in this library you need to initialize the random library `quickrand` before calling. This has to occur in the same Erlang process as the calls to the UUID library.
23+
24+
If you use the functions `uuid:new/1`, `uuid:new/2` or `uuid:get_v4_urandom/0`, you must have called the function `quickrand:seed/0` first.
25+
26+
For `uuid:get_v4(:cached)` you must have called the function `quickrand_cache.init/0` first.
2227

2328
Build
2429
-----

0 commit comments

Comments
 (0)