diff --git a/README.md b/README.md index ef6b611..0b4d20e 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ -# rearrange \ No newline at end of file +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"`