Sobre o readme do projeto (necessidade de uma estrura basica?)

[luisfernandezbr]

Estou sentido falta de um readme minimamente estruturado, que inclusive tenha um padrão para ser replicado para todas as outras libs.

Ideias?

@leoleomaia
@carlosalexandre3107
@alexandreant
@brenol
@WellingtonSilva1992
@tigosante

[luisfernandezbr]

Uma proposta de estrutura para o README.md.

https://github.com/mobiplus-opensource/mobiplus-version-blocker-lib

Depois explico o motivo de ter colocado em outro projeto.

[WellingtonSilva1992]

Tem como dar acesso?

[tigosante]

Vamos usar essa estrutura, sugerida, inicialmente no projeto.

[carlosalexandre3107]

Eu achei com completa a proposta do Luis. Acho que faz sentido seguimos com ele e ir evoluindo baseado no feedback da galera que for usando ela como base.

[WellingtonSilva1992]

Estou evoluindo nosso readme a partir do modelo proposto. Aguardamos mais contribuições, senhores!

[alexandreant]

Achei muito boa estrutura, mas senti falta do "Como usar" mostrando como a implementação seria muito simples, que pra mim é uma das partes mais vendedoras de uma lib.