From ea1405a5ede9ddfa170d7ab216c730ebaf56bd0e Mon Sep 17 00:00:00 2001 From: Aglika Date: Tue, 12 May 2020 10:31:56 -0400 Subject: [PATCH] Add a simple README.md file including an example use case --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e8d493 --- /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"`