From f969c41ac805461b0fe617e71735523fdb91d058 Mon Sep 17 00:00:00 2001 From: mook17n1 Date: Tue, 17 Oct 2023 05:05:32 -0400 Subject: [PATCH] Add a simple README.md file including an example use case --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index aaf931d..0bb9870 100644 --- a/README.md +++ b/README.md @@ -9,3 +9,16 @@ Turns "LastName, FirstName" into "FirstName LastName" * Calling 'reaarange_name("Turing, Alan")' will return '"Alan Turing"' * Calling 'reaarange_name("Hopper, Grace M.")' will return '"Grace M. Hopper"' * Calling 'reaarange_name("Voltaire")' will return '"Voltaire"' + +Rearrange +========= + +This module is used for rearranging names. +Turns "LastName, FirstName" into "FirstName LastName" + +## Example + + * Calling 'reaarange_name("Turing, Alan")' will return '"Alan Turing"' + * Calling 'reaarange_name("Hopper, Grace M.")' will return '"Grace M. Hopper"' + * Calling 'reaarange_name("Voltaire")' will return '"Voltaire"' +