diff --git a/README.md b/README.md index ef6b611..86f4cb3 100644 --- a/README.md +++ b/README.md @@ -1 +1,9 @@ -# rearrange \ No newline at end of file + rearrange +=========== +This module is used for rearranging names. +Turn "LASTNAME, FIRSTNAME" into FIRSTNAME LASTNAME." + +##Example +* calling `rearrange_name("Turing, Alain")` will return `"Alain Turing"` +* calling `rearrange_name("Ali, Cali")` will return `"Cali Ali"` +* calling `rearrange_name("Dan, Lee")` will return `"Lee Dan"`