Improved README.md and setup.py and added MANIFEST.in

Author: g1ca

MANIFEST.in

@@ -0,0 +1,3 @@
+include requirements.txt
+include README.md
+include LICENSE

README.md

@@ -9,15 +9,29 @@ All you need to send requests is your own api key which you can get from nameapi
 
 This library requires at least Python 3.8.
 
+## Installation
 
+You have two options to get the 'nameapi-client-python' library:
 
-## Library setup
+### 1. Download library from PyPI
+
+<pre>
+pip install nameapi-client-python
+</pre>
+
+### 2. Download library from GitHub
 
 Create virtual environment and activate it:
 
     python -m venv myenv
     myenv\Scripts\activate
 
+Clone the repository
+    
+    git clone https://github.com/optimaize/nameapi-client-python.git
+    cd nameapi-client-python
+
+
 Install the required libraries:
 
     pip install -r requirements.txt
@@ -49,7 +63,7 @@ and is very convenient in accepting the data however you have it at hands.
 Creating a simple person looks something like this:
 
 ```python
-name_object = WesternInputPersonNameBuilder().fullname("Petra Müller").build()
+name_object = WesternInputPersonNameBuilder().fullname("John F. Kennedy").build()
 input_person = NaturalInputPersonBuilder().name(name_object).build()
 ```
 
@@ -68,7 +82,6 @@ name_object_2 = WesternInputPersonNameBuilder() \
 name_object_3 = WesternInputPersonNameBuilder() \
     .name_field(NameField("Petra", CommonNameFieldType.GIVENNAME)) \
     .name_field(NameField("Müller", CommonNameFieldType.SURNAME)) \
-    .name_field(NameField("Alexa", AmericanNameFieldType.MIDDLENAME)) \
     .build()
 
 name_object_4 = InputPersonName([NameField("petra müller", CommonNameFieldType.FULLNAME)])
@@ -80,7 +93,7 @@ Creating complex input person objects:
 input_person = NaturalInputPersonBuilder() \
             .name(name_object_1) \
             .gender(StoragePersonGender.MALE) \
-            .add_email("email@address.com") \
+            .add_email("email@example.com") \
             .add_tel_number("+5555555") \
             .age(BirthDate(year=1999, month=2, day=1))\
             .build()
@@ -90,7 +103,7 @@ input_person = NaturalInputPersonBuilder() \
 
 Response from the requests, displayed as json: https://api.nameapi.org/rest/swagger-ui/
 
-Access the link above to see all the return type and their json format.
+Access the link above to see all the return types and their json format.
 
 
 ## Commands
@@ -111,7 +124,7 @@ Name parsing is the process of splitting a full name into its components.
 ```python
 api_key = None  # Set your api_key here
 client = NameApiClient(api_key)
-response = client.person_name_parser(input_person_1)
+response = client.person_name_parser(input_person)
 ```
 
 
@@ -123,7 +136,7 @@ Name genderizing is the process of identifying the gender based on a person's na
 ```python
 api_key = None  # Set your api_key here
 client = NameApiClient(api_key)
-response = client.person_genderizer(input_person_1)
+response = client.person_genderizer(input_person)
 ```
 
 
@@ -136,6 +149,12 @@ This service takes 2 people as input:
 ```python
 api_key = None  # Set your api_key here
 client = NameApiClient(api_key)
+
+name_object_1 = WesternInputPersonNameBuilder().fullname("John F. Kennedy").build()
+input_person_1 = NaturalInputPersonBuilder().name(name_object).build()
+name_object_2 = WesternInputPersonNameBuilder().fullname("Jack Kennedy").build()
+input_person_2 = NaturalInputPersonBuilder().name(name_object).build()
+
 response = client.person_matcher(input_person_1, input_person_2)
 ```
 
@@ -147,7 +166,7 @@ The Name Formatter displays personal names in the desired form. This includes th
 ```python
 api_key = None  # Set your api_key here
 client = NameApiClient(api_key)
-response = client.person_name_formatter(input_person_1)
+response = client.person_name_formatter(input_person)
 ```
 
 ## Risk Detector
@@ -157,7 +176,7 @@ Detects various types of possibly fake data in person records.
 ```python
 api_key = None  # Set your api_key here
 client = NameApiClient(api_key)
-response = client.risk_detector(input_person_1)
+response = client.risk_detector(input_person)
 ```
 
 
@@ -169,7 +188,7 @@ The Email Name Parser extracts names out of email addresses.
 ```python
 api_key = None  # Set your api_key here
 client = NameApiClient(api_key)
-email_address="[email protected]"
+email_address="[email protected]"
 response = client.email_name_parser(email_address)
 ```
 
@@ -181,7 +200,7 @@ The DEA-Detector checks email addresses against a list of known "trash domains"
 ```python
 api_key = None  # Set your api_key here
 client = NameApiClient(api_key)
-email_address="someaddress@gmail.com"
+email_address="someone@10minutemail.com"
 response = client.disposable_email_detector(email_address)
 ```
 

setup.py

@@ -1,20 +1,25 @@
 from setuptools import setup, find_packages
 
-with open("README.md", "r") as fh:
+with open("README.md", "r", encoding="UTF-8") as fh:
     long_description = fh.read()
 
-with open("requirements.txt", "r") as f:
+with open("requirements.txt", "r", encoding="UTF-8") as f:
     requirements = [line.strip() for line in f]
 
 setup(
     name='nameapi-client-python',
-    version='1.0.0',
-    description='Python Client for the NameAPI Web Service ',
+    version='1.0.1',
+    description='Python Client for the NameAPI Web Services',
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/optimaize/nameapi-client-python",
+    url="https://www.nameapi.org/",
+    project_urls={
+        'Source Code': 'https://github.com/optimaize/nameapi-client-python',
+        'Bug Tracker': 'https://github.com/optimaize/nameapi-client-python/issues',
+    },
     packages=find_packages(),
-    keywords=['nameapi', 'rest nameapi', 'nameapi client', 'python nameapi', 'nameapi python client'],
+    keywords=['nameapi', 'rest nameapi', 'nameapi client', 'name parser', 'name matcher', 'person risk detector',
+              'name genderizer', 'email name parser', 'email parser', 'disposable email detector', 'dea detector'],
     test_suite='tests/tests.py',
     classifiers=[
         'Programming Language :: Python :: 3',