From cbc24e948d4c92def6ff5df389369d042326fb88 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jo=C3=A3o=20Pedro=20Kaspary?= <joaopedrokaspary@hotmail.com>
Date: Thu, 18 May 2023 16:30:53 -0300
Subject: [PATCH] docs: documentation of the project usage

---
 LICENSE          | 24 +++++++++++++++++++++
 README.md        | 55 +++++++++++++++++++++++++++++++++++++++++++++++-
 requirements.txt |  0
 setup.py         | 19 +++++++++++++++++
 4 files changed, 97 insertions(+), 1 deletion(-)
 create mode 100644 LICENSE
 create mode 100644 requirements.txt

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..fdddb29
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>
diff --git a/README.md b/README.md
index 869c591..6442e20 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,59 @@
 
 
 # Email SDK Hub
+This is a project for implementing an interface to send emails with different servers.
 
-This is a project for implement an interface to send email with different emails server.
+## Install
+Do you can install this project directly in yor project. To do this, follow the next step.
+```bash
+pip install git+https://github.com/Kaspary/email-hub-sdk.git
+```
 
+## Local Usage
+
+### Requirements
+- Python 3.7 or more.
+- Virual Envorniment Python (Recomended).
+- Make (optional). 
+
+### Commands
+To make easy startup of the project, the common commands were configurated in the `makefile`.
+
+#### Example
+To create the virtual environment, execute the following command.
+```bash
+make create-venv
+```
+
+**Commands**
+* `create-venv` - Create the virtual environment for the project (the module **venv** is necessary).
+* `setup` - Install the requirements from **requirements.txt**.
+* `clean` - Remove all temporary files from the project, including the coverage folder.
+* `code-convention` - Execute the tools to verify the code convention.
+* `test` - Run all the tests of the project.
+* `test-cov` - Generate the test coverage report.
+
+## Project layout
+
+```
+.
+├── Makefile
+├── README.md
+├── reports
+│   └── coverage
+├── setup.cfg
+├── setup.py
+├── src
+│   ├── adapters.py
+│   ├── clients.py
+│   ├── enums.py
+│   ├── facades.py
+│   ├── __init__.py
+│   └── services.py
+└── tests
+    ├── __init__.py
+    ├── test_adapters.py
+    ├── test_clients.py
+    ├── test_facades.py
+    └── test_services.py
+```
\ No newline at end of file
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..e69de29
diff --git a/setup.py b/setup.py
index e69de29..bc0334d 100644
--- a/setup.py
+++ b/setup.py
@@ -0,0 +1,19 @@
+import setuptools
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setuptools.setup(
+    name="email-hub-sdk",
+    version="0.0.1",
+    author="João Pedro Kaspary",
+    author_email="jpkasparydev@gmail.com",
+    description="Package for implement an interface to send email with different server.",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/Kaspary/email-hub-sdk",
+    project_urls={"Bug Tracker": "https://github.com/Kaspary/email-hub-sdk/issues"},
+    license="UNLICENSED",
+    packages=["email-hub-sdk"],
+    install_requires=[],
+)