diff --git a/README.md b/README.md new file mode 100644 index 00000000..8667a56f --- /dev/null +++ b/README.md @@ -0,0 +1,12 @@ +Rearrange +========= + +This module is used for rearranging names. + +Turns "LastName, FirstName" into "FirstName LastName". + +## EXAMPLE + + * Calling `"rearrange_name("Turing, Alan")` will return `"Allan Turing"` + * Calling `"rearrange_name("Hopper, Grace M.")` will return `"Grace M. Hopper"` + * Calling `"rearrange_name("Voltaire")` will return `"Voltaire"`