aboutsummaryrefslogtreecommitdiff
path: root/node_modules/rndm/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/rndm/README.md')
-rw-r--r--node_modules/rndm/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/node_modules/rndm/README.md b/node_modules/rndm/README.md
new file mode 100644
index 0000000..504b1fd
--- /dev/null
+++ b/node_modules/rndm/README.md
@@ -0,0 +1,27 @@
+
+# RNDM
+
+Random string generator.
+Basically `Math.random().toString(36).slice(2)`,
+but with both upper and lower case letters and arbitrary lengths.
+Useful for creating fast, not cryptographically secure salts.
+
+## API
+
+```js
+// base62 by default
+var rndm = require('rndm')
+var salt = rndm(16)
+```
+
+### var salt = rndm(length)
+
+### var salt = rndm.base62(length)
+
+### var salt = rndm.base36(length)
+
+### var salt = rndm.base10(length)
+
+### var random = rndm.create(characters)
+
+Create a new random generator with custom characters.