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

update readme

Browse source
This commit is contained in:
AJ Hoffer 2020-02-21 16:50:18 -05:00
parent 52344b1b5a
commit 6c2d6f4657
1 changed files with 19 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
readme.md
View file

@ -10,72 +10,60 @@ Usage
```csharp ```csharp
// this will generate a string with three words: // this will generate a string with three words:
string words = LoremNET.Lorem.Words(3); string words = LoremNET.Generate.Words(3);
// this will generate a string with two to five words: // this will generate a string with two to five words:
string words = LoremNET.Lorem.Words(2, 5); string words = LoremNET.Generate.Words(2, 5);
// this will generate a string with five to ten words with "uppercaseFirstLetter" set to "false" and "includePunctuation" set to "true": // this will generate a string with five to ten words with "uppercaseFirstLetter" set to "false" and "includePunctuation" set to "true":
string words = LoremNET.Lorem.Words(5, 10, false, true); string words = LoremNET.Generate.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: // 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 = LoremNET.Lorem.Sentence(5, 10); string sentence = LoremNET.Generate.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: // 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 = LoremNET.Lorem.Paragraph(5, 6, 4, 10); string paragraph = LoremNET.Generate.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: // 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 = LoremNET.Lorem.Paragraphs(8, 9, 4, 5, 1, 3); string[] paragraphs = LoremNET.Generate.Paragraphs(8, 9, 4, 5, 1, 3);
``` ```
### Extras ### Extras
```csharp ```csharp
// this will generate a random valid email address: // this will generate a random valid email address:
string email = LoremNET.Lorem.Email(); string email = LoremNET.Generate.Email();
// this will generate a random hex number (i.e. a color) // this will generate a random hex number (i.e. a color)
string hex = LoremNET.Lorem.HexNumber(); string hex = LoremNET.Generate.HexNumber();
// this will generate a random DateTime object between 1/1/1950 and the current DateTime: // this will generate a random DateTime object between 1/1/1950 and the current DateTime:
DateTime dateTime = LoremNET.Lorem.DateTime(); DateTime dateTime = LoremNET.Generate.DateTime();
// this will generate a random DateTime object between 1/1/1995 and 12/31/2020: // this will generate a random DateTime object between 1/1/1995 and 12/31/2020:
DateTime dateTime = LoremNET.Lorem.DateTime(new DateTime(1995, 1, 1), new DateTime(2020, 12, 31)) DateTime dateTime = LoremNET.Generate.DateTime(new DateTime(1995, 1, 1), new DateTime(2020, 12, 31))
// this will return "true" 55% of the time: // this will return "true" 55% of the time:
bool isTruth = LoremNET.Lorem.Chance(55, 100); bool isTruth = LoremNET.Generate.Chance(55, 100);
// this will randomly select an item from the group: // this will randomly select an item from the group:
string[] numbers = GetNumbers(); string[] numbers = GetNumbers();
string number = LoremNET.Lorem.Random(numbers); string number = LoremNET.Generate.Random(numbers);
// this will randomly select a value from the enum: // this will randomly select a value from the enum:
MyEnum value = LoremNET.Lorem.Enum<MyEnum>(); MyEnum value = LoremNET.Generate.Enum<MyEnum>();
``` ```
### RandomHelper ### Updateing the Source
Lorem.NET includes a thread-safe System.Random instance. If you want to change the underlying source text, go right ahead!
```csharp ```csharp
int i = LoremNET.RandomHelper.Instance.Next(1, 2); public void SomeStartupMethod()
```
### Extending the Class
If you want to extend the class to add more methods, go right ahead!
```csharp
namespace LoremNET
{ {
public partial class Lorem LoremNET.Source.Update("Alright stop collaborate and listen ice is back with my brand new invention something grabs a hold of me tightly flow like a harpoon daily and nightly will it ever stop yo I don't know turn off the lights and I'll glow");
{
public static string Email(string domain) ...
{
return Email().Replace(".com", string.Format(".{0}", domain));
}
}
} }
``` ```