Readme para ajudar a contribuir

[gilbertoca]

Pessoal, um draft que tenho em mente para melhorar o README. As seções Building e Running precisam ser bem mais claras. O que acham?

Caelum Stella

Alguns processos são comuns e recorrentes em sistemas voltados para o público brasileiro. O Stella vai te auxiliar nesse caso, oferecendo uma API simples para validação e formatação de CPF, CNPJ e outros cadastros comuns no Brasil. Além de oferecer uma API para trabalhar com boletos, números e integração com JSF, JPA/Hibernate etc.

Build status

• TravisCI:
  • 
• Apache Jenkins:
  • Linux: ![Build Status](
  • Windows:

Requirements

• Git
• Maven 3.5 or above
• Oracle JDK 7 or OpenJDK 7

Building

Fork este repositório
Vá para a página do projeto forked e clone o mesmo em seu computador via git clone link-to-your-forked-repo-here
Digite git remote -v confirmando que origin aparece e aponte para o repositório remoto que fez o fork
Em seguida, digite git remote add upstream https://github.com/caelum/caelum-stella.git
Verifique novamente via git remote -v
Certifique-se que origin e upstream estejam configurados
Pronto, use seu IDE ou o maven

$ mvn install

Running

Use o artefato construído, colocando-o no classpath de sua aplicação através do maven ou diretamente

[angeliski]

Boa @gilbertoca ! Acredito que esse draft seja um começo legal.
No running talvez podemos fazer um link de um projeto exemplo, pro cara só baixar e usar, saca? Eu tenho um que eu uso para fazer os testes de PR (https://github.com/angeliski/caelum-boleto-test)