From 9ca389c90aedcda80a6a5fc6ec8d77befbd98968 Mon Sep 17 00:00:00 2001
From: Jonathan Flueren <jonathan.flueren@tu-dortmund.de>
Date: Fri, 7 Jul 2023 18:23:39 +0200
Subject: [PATCH] Improve README.md

---
 README.md | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

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 `<span>Entry<br></span>` will be converted into `<schman>Schmentry<schmer></schman>`.
\ No newline at end of file