chore: update instalation doc (#6)

* chore: update instalation doc * chore: create test doc * chore: update doc * chore: update readme
madeiramadeirabr · Oct 5, 2023 · 2b21c30 · 2b21c30
1 parent 416ed1f
commit 2b21c30
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -15,32 +15,9 @@ Biblioteca em Node que implementa a [MMRFC](https://madeiramadeira.atlassian.net
 Mantida pelo de SRE
 Aberto para qualquer equipe atualizar e implementar funcionalidades
 
-## Desenvolvimento
-Para ambiente de desenvolvimento
-
-```bash
-
-```
-
-## Testes
-Para rodar os testes, raíz do projeto você deve rodar:
-
-```bash
-$ npm run test
-```
-
-### Coverage
-Para gerar o code coverage, raíz do projeto você deve rodar:
-```bash
-$ npm run test:coverage
-```
-
-### Badges
-Para gerar os badges de coverage, raíz do projeto você deve rodar:
-```bash
-$ npm run test:badges
-```
 
 ## Instruções para uso da biblioteca
-
-[Acessar documentação](./docs/README.md)
+- [Documentação técnica](./docs/README.md)
+    - [Instalação](./docs/instalacao.md)
+    - [Como utilizar](./docs/uso.md)
+    - [Executando os testes](./docs/tests.md)
diff --git a/docs/README.md b/docs/README.md
@@ -1,8 +1,8 @@
 # Documentação Técnica
 
 - [Instalação](./instalacao.md)
-- Uso
-  - [Node JS](./uso.md)
+- [Como utilizar](./uso.md)
+- [Executando os testes](./tests.md)
 
 ## Versões suportadas
 
@@ -15,4 +15,4 @@ Todas as versões são garantidas por testes unitários que são testados no mom
 
 ## Configuração
 
-Checar o arquivo Nodejs para NestJs checar o arquivo NestJs
+Checar o arquivo Nodejs para NestJs checar o arquivo NestJs
diff --git a/docs/instalacao.md b/docs/instalacao.md
@@ -3,5 +3,7 @@
 Para instalar a biblioteca de Logs, execute o seguinte comando:
 
 ```bash
-$ npm install https://github.com/madeiramadeirabr/lib-node-logger --save
+npm install https://github.com/madeiramadeirabr/lib-node-logger#<version>
+# Exemplo: npm install https://github.com/madeiramadeirabr/lib-node-logger#1.0.1
 ```
+
diff --git a/docs/tests.md b/docs/tests.md
@@ -0,0 +1,19 @@
+# Testes
+Para rodar os testes execute os seguintes comandos na raíz do projeto:
+
+### Testes unitários
+```bash
+$ npm run test
+```
+
+### Coverage
+Para gerar o code coverage, raíz do projeto você deve rodar:
+```bash
+$ npm run test:coverage
+```
+
+### Badges
+Para gerar os badges de coverage, raíz do projeto você deve rodar:
+```bash
+$ npm run test:badges
+```