From da86409ec1850f916a179f8e591b084f8c3c7121 Mon Sep 17 00:00:00 2001 From: TXMack713 Date: Thu, 12 Oct 2023 12:40:14 -0500 Subject: [PATCH] Added a simple README.md file including some example use cases. --- 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 00000000..980ed295 --- /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"`. \ No newline at end of file