Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Tiny grammer and spelling fixes
  • Loading branch information
M-Zuber committed Jan 8, 2019
1 parent 169bfd2 commit 6927e0f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -71,11 +71,11 @@ The `IUniqueness` interface allows you to enforce global uniquness on the codes

### Stop Words

StopWords (`IStopWords`) provides a mechanism to filter out codes that may be deemed inappropriate or incorrect. You can live on the edge by using the default `NoStopWords`. If you like it boring, you can also use the `InMemoryStopWords` implementation and provide inappropriate words there, which uses and `IndexOf` implementation to find matches.
StopWords (`IStopWords`) provides a mechanism to filter out codes that may be deemed inappropriate or incorrect. You can live on the edge by using the default `NoStopWords`. If you like it boring, you can also use the `InMemoryStopWords` implementation and provide inappropriate words there, which uses an `IndexOf` implementation to find matches.

### Transformers

The transformer (`ITransfomer`) interface allows you to take a uniquely generated code and transform it into something else. The transfomer will only run when the result is a `Success`. **Note, The uniqueness of the code coming from a transfomer is not garaunteed.**
The transformer (`ITransfomer`) interface allows you to take a uniquely generated code and transform it into something else. The transfomer will only run when the result is a `Success`. **Note, The uniqueness of the code coming from a transfomer is not guaranteed.**

There is a sample in which this libary is used to [generate unique container names](https://github.com/khalidabuhakmeh/codez/blob/master/test/Tests/TransformerTests.cs).

Expand All @@ -91,4 +91,4 @@ Options allow you to alter the behavior of the code generation:

## Contributors

- [Tim VanFosson](https://github.com/tvanfosson)
- [Tim VanFosson](https://github.com/tvanfosson)

0 comments on commit 6927e0f

Please sign in to comment.