start improving README

Webifi · Dec 15, 2016 · 508e138 · 508e138
1 parent 0acd01c
commit 508e138
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,13 +1,19 @@
 # TheIconic Name Parser
 
+This is a universal, language-independent name parser.
+
+Its purpose is to split a single string containing a full name,
+possibly including salutation, initials, suffixes etc., into
+meaningful parts like firstname, lastname, initials, and so on.
+
 ## Usage
 
 ```
 <?php
 
 $parser = new TheIconic\NameParser\Parser();
 
-$name = $parser->parse($name);
+$name = $parser->parse($input);
 
 echo $name->getSalutation();
 echo $name->getFirstname();