Skip to content
This repository has been archived by the owner on May 28, 2023. It is now read-only.

Reformular README do projeto #33

Closed
jessescn opened this issue Mar 4, 2021 · 1 comment
Closed

Reformular README do projeto #33

jessescn opened this issue Mar 4, 2021 · 1 comment

Comments

@jessescn
Copy link
Member

jessescn commented Mar 4, 2021

Descrição da melhoria:
Definir de forma mais clara qual o objetivo do projeto, além do funcionamento geral de por quê o projeto existe e qual problema ele tenta resolver, além de coisas bonitas e tudo mais

Como ela pode ser implementada:
Alterando o arquivo README e pedindo pull request para a branch master. lembrando que qualquer dúvida pode perguntar para @JoseRenan @jessescn ou @paulojbleitao.

@paulojbleitao
Copy link

Uma possível inspiração é a documentação do npm. Olhando por cima, a seção "Use npm to..." parece uma boa ideia, exemplificando os casos de uso

@davigps davigps closed this as completed May 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants