Added a simple README.md file including some example use cases.

TXMack713 · Oct 12, 2023 · da86409 · da86409
1 parent 89c3368
commit da86409
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+Rearrange
+=========
+
+This module is used for rearranging names.
+Turns "LastName, FirstName" into "FirstName LastName".
+
+## Example
+
+* Calling `rearrange_name("Turing, Alan")` will return `"Alan Turing"`.
+* Calling `rearrange_name("Hopper, Grace M.")` will return `"Grace M. Hopper"`.
+* Calling `rearrange_name("Voltaire")` will return `"Voltaire"`.