Doc

README.md

@@ -1,8 +1,43 @@
-## Instruções
-Hello world:
-1) Importar projeto na IDE
-2) Build + run
-3) Abrir no navegador
-> http://localhost:8080/listall/fulano
-
-Descrições sobre o que faz cada coisa estão dentro das classes.
+<p align='center'>
+<img src='https://raw.githubusercontent.com/FerramONG/ferramong-auth/master/docs/img/logo/logo.png?raw=true' />
+</p>
+
+<h1 align='center'>FerramONG - Auth</h1>
+<p align='center'>Service responsible for the authentication and registration of users, in addition, it also generates and validates session tokens.</p>
+<p align="center">
+	<a href="https://github.com/FerramONG/ferramong-auth/actions/workflows/windows.yml"><img src="https://github.com/FerramONG/ferramong-auth/actions/workflows/windows.yml/badge.svg" alt=""></a>
+	<a href="https://github.com/FerramONG/ferramong-auth/actions/workflows/macos.yml"><img src="https://github.com/FerramONG/ferramong-auth/actions/workflows/macos.yml/badge.svg" alt=""></a>
+	<a href="https://github.com/FerramONG/ferramong-auth/actions/workflows/ubuntu.yml"><img src="https://github.com/FerramONG/ferramong-auth/actions/workflows/ubuntu.yml/badge.svg" alt=""></a>
+	<a href="http://java.oracle.com"><img src="https://img.shields.io/badge/java-12+-D0008F.svg" alt="Java compatibility"></a>
+	<a href="https://github.com/FerramONG/ferramong-auth/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-BSD0-919191.svg" alt="License"></a>
+	<a href="https://github.com/FerramONG/ferramong-auth/releases"><img src="https://img.shields.io/github/v/release/FerramONG/ferramong-auth" alt="Release"></a>
+</p>
+<hr />
+
+## ❇ Introduction
+This source code is a webservice that is used to manage and manipulate the amount of credit that each user has, in addiction to adding or removing the user's credits.
+
+## ❓ How to use
+See [here](https://ferramong-auth.herokuapp.com/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config) OpenAPI doc.
+
+## ⚠ Warnings
+The hosting service Heroku may have a certain delay (~ 1 min) for uploading the application so the loading of the website may have a certain delay. 
+
+## 🚩 Changelog
+Details about each version are documented in the [releases section](https://github.com/FerramONG/ferramong-auth/releases).
+
+## 🗺 Project structure
+#### FerramONG architecture
+![global-schema](https://raw.githubusercontent.com/FerramONG/ferramong-auth/master/docs/img/schemas/architecture.png?raw=true)
+
+#### Creditools class diagram
+![class-diagram](https://raw.githubusercontent.com/FerramONG/ferramong-auth/master/docs/img/diagrams/class-diagram.png?raw=true)
+
+## 📁 Files
+### /
+|        Name 	|Type|Description|
+|----------------|-------------------------------|-----------------------------|
+|dist |`Directory`|Released versions|
+|docs |`Directory`|Documentation files|
+|src     |`Directory`| Source files |
+|test     |`Directory`| Test files |