Skip to content

Commit

Permalink
ajustes readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ribeirober1208 committed Nov 2, 2023
1 parent 7a2d3ea commit 224f51d
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,25 @@ Quarto projeto desenvolvido para o bootcamp da [@Laboratória](https://www.labor

***

## Prefácio
## 1. Prefácio

Markdown é usada em muitas plataformas que manipulam texto (GitHub, fórum, blogs e etc) e é muito comum encontrar arquivos com este formato em qualquer repositório (começando pelo tradicional README.md). Os arquivos Markdown normalmente contém links que podem estar quebrados, ou que já não são válidos, prejudicando muito o valor da informação que está ali.

Nesse projeto, criou-se uma ferramenta, usando Node.js, que le e analise arquivos no formato Markdown, para verificar os arquivos que contenham links e mostrar algumas estatísticas. Neste projeto, foi criado uma ferramenta de linha de comando (CLI) assim como a sua própria biblioteca (library) em Javascript usando o Node.js.

## Fluxograma
## 2. Fluxograma

![Fluxograma](./gallery/Fluxograma_MD-links%20(1).png)

## Instalação
## 3. Instalação

Instale a biblioteca no terminal através do comando:

```
npm install https://github.com/ribeirober1208/MD-Links
```

## Terminal e seus comandos
## 4. Terminal e seus comandos

- Comando validate:

Expand Down Expand Up @@ -65,13 +65,13 @@ md-links ./files/empty.md --validate
![--stats Doc vazio](./gallery/statsZero.png)


## Testes
## 5. Testes

- A aplicação tem 100% de cobertura:

![--stats Doc vazio](./gallery/teste.png)

## Checklists de Objetivos Alcançados
## 6. Checklists de Objetivos Alcançados

- [:star2:] Possui CLI.
- [:star2:] É instalável.
Expand Down

0 comments on commit 224f51d

Please sign in to comment.