docs(readme): atualização do readme e exclusão da página

BREAKING CHANGE: v2.0.0 fix #12, #5, #3, #2
ServeRest · May 18, 2020 · b844128 · b844128
1 parent 4d8456c
commit b844128
Show file tree

Hide file tree

Showing 12 changed files with 41 additions and 259 deletions.
diff --git a/README.md b/README.md
@@ -1,36 +1,69 @@
 
-# ServeRest
+<h1 align="center">ServeRest@2.0.0</h1>
 
 **Servidor REST local de forma rápida e simples para estudo de testes de API**
 
 [![npm version](https://badge.fury.io/js/serverest.svg)](https://npmjs.com/package/serverest)
 [![BCH compliance](https://bettercodehub.com/edge/badge/PauloGoncalvesBH/serverest?branch=master)](https://bettercodehub.com/results/PauloGoncalvesBH/serverest)
 [![Continuous Integration](https://github.com/PauloGoncalvesBH/serverest/workflows/Continuous%20Integration/badge.svg)](https://github.com/PauloGoncalvesBH/serverest/actions)
-![npm total downloads](https://img.shields.io/npm/dt/serverest.svg)
+[![npm total downloads](https://img.shields.io/npm/dt/serverest.svg)](https://npmjs.com/package/serverest)
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2FPauloGoncalvesBH%2Fserverest.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2FPauloGoncalvesBH%2Fserverest?ref=badge_shield)
 
 ---
 
- Dispõe de um servidor REST com dados de escola fictícia, permitindo o estudo do uso de autenticação, manipulação de resposta, requisições aninhadas e principais verbos.
+## Executando o ServeRest
+
+```sh
+npx serverest
+```
 
-Todos os endpoints disponíveis aceitam os verbos *GET, POST, PUT, PATCH* e *DELETE* e utilizam de token de autenticação no header.
+Dispõe de um servidor REST com dados de e-commerce fictício, permitindo o estudo do uso de:
+- Verbos *GET, POST, PUT* e *DELETE*
+- Autenticação no header
+- Query string
+- Contrato
+- Manipulação de resposta
+- Requisições aninhadas
 
 ## Links
 
-- **[Documentação](https://serverest.js.org/)**
 - **[Histórico de alterações](/CHANGELOG.md)**
 - [Código de conduta](/CODE_OF_CONDUCT.md)
 - [Como contribuir](/CONTRIBUTING.md)
 
-## Executando o ServeRest
+## Rotas disponíveis
+
+Ao iniciar o _ServeRest_ automaticamente a rota `/api-doc` é executada, abrindo a documentação, que lista todas as rotas, verbos, contratos e repostas possíveis.
+
+<details><summary>Abra para ver imagem das rotas disponíveis</summary>
+
+![Lista de rotas disponibilizdas pelo ServeRest](./img/rotas.png)
+
+---
+
+</details>
+
+> Para evitar que a documentação seja aberta automaticamente envie o comando `npx serverest --nodoc`
+
+## Configuração
+
+Para visualizar as configurações que são possíveis de serem feitas execute o comando
 
 ```sh
-npx serverest
+npx serverest -h
 ```
 
+<details><summary>Abra para ver imagem do terminal com os comandos de configuração</summary>
+
+![Informação de opções e exemplos fornecidos no terminal](./img/terminalHelp.png)
+
+---
+
+</details>
+
 ## Preciso de ajuda
 
-Está com algum problema e precisa de ajuda? Abra uma [issue aqui](https://github.com/PauloGoncalvesBH/serverest/issues) detalhando a sua situação.
+Está com algum problema e precisa de ajuda? Abra uma [issue](https://github.com/PauloGoncalvesBH/serverest/issues) detalhando a sua situação.
 
 ## Licença
 

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/CNAME b/docs/CNAME
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
diff --git a/docs/img/terminalDebugMode.jpg b/docs/img/terminalDebugMode.jpg
diff --git a/docs/img/terminalHelp.png b/docs/img/terminalHelp.png
diff --git a/docs/img/terminalRequests.png b/docs/img/terminalRequests.png
diff --git a/docs/img/terminalServidorDePe.png b/docs/img/terminalServidorDePe.png
diff --git a/docs/index.html b/docs/index.html
diff --git a/img/rotas.png b/img/rotas.png
diff --git a/img/terminalHelp.png b/img/terminalHelp.png