diff --git a/README.md b/README.md new file mode 100644 index 00000000..27f31557 --- /dev/null +++ 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"`