Update README.md

auronandace · Dec 8, 2022 · 9c08ed4 · 9c08ed4
1 parent c81bba3
commit 9c08ed4
Showing 1 changed file with 14 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,15 @@
 # acorn_prng
-A pseudo-random number generator based on the ACORN algorithm.
+A pseudo-random number generator library based on the ACORN algorithm.
+Not cryptographically secure.
+
+# Using this library
+Add the following to the [dependencies] section of your Config.toml:
+```
+acorn_prng = "1.0.0"
+```
+
+# Documentation
+Documentation can be found here: https://docs.rs/acorn_prng
+
+# Acknowledgements
+The ACORN algirithm is described here: http://acorn.wikramaratna.org/concept.html