From 6ecbd2acacd2924a2e396b94508646f18d015d35 Mon Sep 17 00:00:00 2001 From: My name Date: Sun, 7 Apr 2024 11:45:34 +0530 Subject: [PATCH] Add a simple README.md file including a 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 00000000..06599dec --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +Rearrange +========= + +This module is used for rearranging names. +Turns "LastName, FirstName" into "FirstName LastName". + +## Examples + + * 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"`