tonytins/Lorem.NET
1
0
Fork 0
mirror of https://github.com/tonytins/Lorem.NET.git synced 2025-03-15 04:32:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

readme edits

Browse source
This commit is contained in:
dochoffiday 2014-08-19 16:42:53 -04:00
parent b901040979
commit dd0fbbc37a
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
readme.md
View file

@ -10,39 +10,39 @@ Usage
```csharp
// this will generate a string with three words:
string words = Lorem.Words(3);
string words = Lorem.NET.Lorem.Words(3);
// this will generate a string with two to five words:
string words = Lorem.Words(2, 5);
string words = Lorem.NET.Lorem.Words(2, 5);
// this will generate a string with five to ten words with "uppercaseFirstLetter" set to "false" and "includePunctuation" set to "true":
string words = Lorem.Words(5, 10, false, true);
string words = Lorem.NET.Lorem.Words(5, 10, false, true);
// a sentence is the same as "Words" except that it will include punctuation by default and will include a "." at the end of a string:
string sentence = Lorem.Sentence(5, 10);
string sentence = Lorem.NET.Lorem.Sentence(5, 10);
// a paragraph is a string composed of multiple sentences; this paragraph will have five to six words per sentence, and four to ten sentences:
string paragraph = Lorem.Paragraph(5, 6, 4, 10);
string paragraph = Lorem.NET.Lorem.Paragraph(5, 6, 4, 10);
// paragraphs is an array of paragraphs; this method will have eight to nine words per sentence, four to five sentences per paragraph, and one to three paragraphs:
string[] paragraphs = Lorem.Paragraphs(8, 9, 4, 5, 1, 3);
string[] paragraphs = Lorem.NET.Lorem.Paragraphs(8, 9, 4, 5, 1, 3);
```
### Extras
```csharp
// this will generate a random valid email address:
string email = Lorem.Email();
string email = Lorem.NET.Lorem.Email();
// this will generate a random DateTime object:
DateTime dateTime = Lorem.DateTime();
DateTime dateTime = Lorem.NET.Lorem.DateTime();
// this will return "true" 55% of the time:
bool isTruth = Lorem.Chance(55, 100);
bool isTruth = Lorem.NET.Lorem.Chance(55, 100);
// this will randomly select an item from the group:
string[] numbers = GetNumbers();
string number = Lorem.Random(numbers);
string number = Lorem.NET.Lorem.Random(numbers);
```
### RandomHelper