From a82266c256784c4af229e026b00a4dcf9e779270 Mon Sep 17 00:00:00 2001
From: Eli Young <elyscape@gmail.com>
Date: Mon, 26 Jan 2015 19:17:53 -0800
Subject: (MODULES-1715) Add fqdn_rand string generators

---
 README.markdown | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'README.markdown')

diff --git a/README.markdown b/README.markdown
index 293a81a..724a48e 100644
--- a/README.markdown
+++ b/README.markdown
@@ -244,6 +244,23 @@ This function flattens any deeply nested arrays and returns a single flat array
 Returns the largest integer less than or equal to the argument.
 Takes a single numeric value as an argument. *Type*: rvalue
 
+#### `fqdn_rand_string`
+
+Generates a random alphanumeric string using an optionally-specified character set (default is alphanumeric), combining the `$fqdn` fact and an optional seed for repeatable randomness.
+
+*Usage:*
+```
+fqdn_rand_string(LENGTH, [CHARSET], [SEED])
+```
+*Examples:*
+```
+fqdn_rand_string(10)
+fqdn_rand_string(10, 'ABCDEF!@#$%^')
+fqdn_rand_string(10, '', 'custom seed')
+```
+
+*Type*: rvalue
+
 #### `fqdn_rotate`
 
 Rotates an array a random number of times based on a node's fqdn. *Type*: rvalue
-- 
cgit v1.2.3