Improve README.md

This commit is contained in:
Jonathan Flueren 2023-07-07 18:23:39 +02:00
parent 4171bc9645
commit 9ca389c90a

View file

@ -1,5 +1,20 @@
# Schmfy library
This library is able to schmfy single words.
This library is able to schmfy any text.
## Usage
Just add this crate to your project and you will be able to use the `schmfy()`-function to turn any word into its 'schmord'.
Example usage:
```rust
use schmfy::schmfy;
fn improve_text(text: &str) {
let improved_text = schmfy(text);
println!("Old and boring: {}", text);
println!("Improved and great: {}", text);
}
```
## Capabilities
The schmfication capabilities are able to preserve text case and any non-alphabetical characters.
If a non-alphabetical character is between two alphabetical strings, both of the alphabetical strings will be interpreted as completely separate words.
For example, the HTML code `<span>Entry<br></span>` will be converted into `<schman>Schmentry<schmer></schman>`.