Added documentation

capjan · Jan 8, 2023 · 2440dce · 2440dce
1 parent cd85db7
commit 2440dce
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/Core/Doc/Text/Generators.md b/Core/Doc/Text/Generators.md
@@ -1,4 +1,5 @@
 # Generators
 
-* [IRandomStringGenerator](./Generators/IRandomStringGenerator.md) - makes it easy to generate alphnumeric strings
-* [ILoremIpsumGenerator](./Generators/ILoremIpsumGenerator.md) - creates random text for placeholder purposes
+- [TextUtilities]()
+- [IRandomStringGenerator](./Generators/IRandomStringGenerator.md) - makes it easy to generate alphnumeric strings
+- [ILoremIpsumGenerator](./Generators/ILoremIpsumGenerator.md) - creates random text for placeholder purposes
diff --git a/Core/Doc/Text/Generators/TextUtilities.md b/Core/Doc/Text/Generators/TextUtilities.md
@@ -0,0 +1,11 @@
+# TextUtilities
+
+TextUtilities are providing methods to quickly generate random text.
+
+- TextUtilities.CreateAlphanumericString(int length);
+- TextUtilities.CreateLoremIpsumText(int wordCount);
+
+```csharp
+var randomString = TextUtilities.CreateAlphanumericString(10);
+var randomText = TextUtilities.CreateLoremIpsumText(4);
+```