OpenDevUFCG / laguinho-cli

Interface de linha de comando (CLI) para publicar e recuperar dados no laguinho-api
MIT License
14 stars 6 forks source link

Reformular README do projeto #33

Closed jessescn closed 3 years ago

jessescn commented 3 years ago

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 commented 3 years ago

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