Added more changes to the README.md

jfalwell · Jun 1, 2024 · 5ad5458 · 5ad5458
1 parent c59e53e
commit 5ad5458
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,4 +1,9 @@
 Rearrange
 =========
 
-This module is used for rearranging names.
+This module is used for rearranging names. 
+Turns "LastName,FirstName" into "Firstname LastName"
+
+# Example
+
+Calling `rearrange_name("Turing, Alan")` will return `"Alan Turing"`