Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- Swap order of transform and filers
- Fix broken hyperlink
  • Loading branch information
kesac authored Dec 5, 2023
1 parent f96c700 commit 3a9aa27
Showing 1 changed file with 15 additions and 14 deletions.
29 changes: 15 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@
## Table of Contents
1. [Quick Start](#quick-start)
1. [Tailoring Characters](#tailoring-characters)
1. [Filtering](#filtering-output)
1. [Transformations](#transformations)
1. [Filtering](#filtering-output)
1. [Installation](#installation)
1. [Compatibility](#compatibility)
1. [License](#license)

## Quick Start
Use the ```NameGenerator``` class to generate names. Call ``Next()`` to get a new name. By default, [a subset of consonants and vowels from the English language](https://github.com/kesac/Syllabore/wiki/What-is-the-DefaultSyllableGenerator%3F) will be used.
Use the ```NameGenerator``` class to generate names. Call ``Next()`` to get a new name. By default, [a subset of consonants and vowels from the English language](https://github.com/kesac/Syllabore/wiki/What-is-the-DefaultSyllableGenerator) will be used.

```csharp
var g = new NameGenerator();
Expand All @@ -45,18 +45,6 @@ Rasse
```
See the [wiki](https://github.com/kesac/Syllabore/wiki) for more examples on how to control things like vowel sequences, consonant positioning, and more!

## Filtering Output
Each ```NameGenerator``` can be configured to prevent specific substrings or patterns from showing up in names. Filtering is completely optional, but is useful in avoiding awkward sounding combinations of characters.

Here is a basic example of preventing substrings from appearing:
```csharp
var g = new NameGenerator()
.DoNotAllow("ist") // Will prevent names like "Misty"
.DoNotAllow("ck"); // Will prevent names like "Brock"
```

See the [wiki](https://github.com/kesac/Syllabore/wiki/Guide-1.2%EA%9E%89-Filtering-Output) for additional examples.

## Transformations
A ```Transform``` is a mechanism for changing a source name into a new, modified name. Call ```UsingTransform()``` on a ```NameGenerator``` to specify one or more transformations:
```csharp
Expand All @@ -73,6 +61,19 @@ Zojiri
```
See the [wiki](https://github.com/kesac/Syllabore/wiki/Guide-1.3%EA%9E%89-Transformations) for additional examples.

## Filtering Output
Each ```NameGenerator``` can be configured to prevent specific substrings or patterns from showing up in names. Filtering is completely optional, but is useful in avoiding awkward sounding combinations of characters.

Here is a basic example of preventing substrings from appearing:
```csharp
var g = new NameGenerator()
.DoNotAllow("ist") // Will prevent names like "Misty"
.DoNotAllow("ck"); // Will prevent names like "Brock"
```

See the [wiki](https://github.com/kesac/Syllabore/wiki/Guide-1.2%EA%9E%89-Filtering-Output) for additional examples.


## Installation
### .NET apps
Syllabore is available as a NuGet package. You can install it from your [NuGet package manager in Visual Studio](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio) (search for "Syllabore") or by running the following command in your NuGet package manager console:
Expand Down

0 comments on commit 3a9aa27

Please sign in to comment.