From aad6b563eadaebef935a52010292f463cc6c1174 Mon Sep 17 00:00:00 2001 From: sheteentz Date: Sun, 4 Jan 2026 22:13:49 +0100 Subject: [PATCH] Modify README-md including an example use case. --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ef6b611..0b4d20e 100644 --- a/README.md +++ b/README.md @@ -1 +1,11 @@ -# rearrange \ No newline at end of file +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"`