From 6415ab2d38488bac8d5f6790e9289895009f9f0e Mon Sep 17 00:00:00 2001
From: zaierw <114910424+zaierw@users.noreply.github.com>
Date: Tue, 4 Oct 2022 17:32:14 +0200
Subject: [PATCH] Add a simple README.md file including an example use case

---
 README.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ef6b611..86f4cb3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,9 @@
-# rearrange
\ No newline at end of file
+ rearrange
+===========
+This module is used for rearranging names.
+Turn "LASTNAME, FIRSTNAME" into FIRSTNAME LASTNAME."
+
+##Example
+* calling `rearrange_name("Turing, Alain")` will return `"Alain Turing"`
+* calling `rearrange_name("Ali, Cali")` will return `"Cali Ali"`
+* calling `rearrange_name("Dan, Lee")` will return `"Lee Dan"`