From 34a82b9a606f9a55707aaeb1df5eb2fbae6115a5 Mon Sep 17 00:00:00 2001 From: Jason Staten Date: Wed, 17 Jun 2020 23:29:55 -0600 Subject: [PATCH] docs and stats --- README.md | 2 ++ nanoid.janet | 14 +++++++++----- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 09bb847..7139919 100644 --- a/README.md +++ b/README.md @@ -46,3 +46,5 @@ secure random bytes. (nanoid/gen-non-secure :size 5) # "vWgzu" ``` + +![goatcounter](https://janet-nanoid.goatcounter.com/count?p=/README.md) diff --git a/nanoid.janet b/nanoid.janet index b3d55ff..2ba426e 100644 --- a/nanoid.janet +++ b/nanoid.janet @@ -4,8 +4,10 @@ (def- masks [15 31 63 127 255]) -(defn gen [&keys {:size size - :alphabet alphabet}] +(defn gen + "Generate secure random ID. Default size of 21." + [&keys {:size size + :alphabet alphabet}] (default size 21) (default alphabet DEFAULT_ALPHABET) @@ -24,9 +26,11 @@ (string/from-bytes ;result))) -(defn gen-non-secure [&keys {:size size - :alphabet alphabet - :rng rng}] +(defn gen-non-secure + "Generate pseudorandom ID. Default size of 21." + [&keys {:size size + :alphabet alphabet + :rng rng}] (default size 21) (default alphabet DEFAULT_ALPHABET) (default rng DEFAULT_RNG)