diff --git a/README.md b/README.md index 922a174..a3cb116 100644 --- a/README.md +++ b/README.md @@ -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'. \ No newline at end of file +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 `Entry
` will be converted into `Schmentry`. \ No newline at end of file