Add a simple README.md file inclduing some example use cases

blue-kale-test · Sep 18, 2024 · d39a4cc · d39a4cc
1 parent 89c3368
commit d39a4cc
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,9 @@
+# Rearrange
+
+This module is used for rearranging names
+Turns "lastname, first name" to first + last
+
+## Examples
+
+- Calling `("Turing, Alan")` returns `"Alan Turing"`
+- Calling `("a, b")` return `"b a"`