diff --git a/README.md b/README.md index 1a391f1..a33bea6 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# rearrange -========= +Rearrange -This module is used for rearranging names. -Turns "LastName, FirstName" into "FirstName LastName". -## Examples +This module is used to rearranging names. +Turns "LastName, FirstNAme" into "FirstName LastName" -*Calling 'rearange_name("Turing, Alan")' will return '"Alan Turing"' -*Calling 'rearange_name("Hopper, Grace M.")' will return '"Grace M. Hopper"' -*Calling 'rearange_name("Voltaire")' will return '"Voltaire"' +## 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"'