search

BrasilAPI / cep-promise

Busca por CEP integrado diretamente aos serviços dos Correios, ViaCEP e outros (Node.js e Browser)
MIT License
2.88k stars 316 forks source link

Atualizar o README.md #16

Closed ftonato closed 8 years ago

ftonato commented 8 years ago

Como sabemos, a documentação de um projeto é uma das partes mais importantes, então segue um modelo básico (incompleto) de um arquivo README.md para descrever o projeto :)

cep-promise

Coverage Status

Busca por CEP integrado ao banco de dados dos Correios - Node.js e Browser

Installation

# via npm
$ npm install cep-promise

# via github
$ git clone https://github.com/filipedeschamps/cep-promise.git

Usage

Setup

$ cd cep-promise
$ npm install

Contributing

  1. Fork it ( https://github.com/filipedeschamps/cep-promise/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Acredito que seria legal adicionar também o tipo de licença e um gif de exemplo (de uso) no terminal o/

O que você acha @filipedeschamps?

filipedeschamps commented 8 years ago

@ftonato perfeito meu caro! Achei top, gostei do modelo Installation, Usage e Contributing. Se puder mandar PR seria show :+1:

filipedeschamps commented 8 years ago

Um detalhe importante é sobre o padrão nas mensagens de commit :) uso da mesma forma que o Anguar faz: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit

Claro, não tem tanto volume como o deles, mas é o mesmo princípio :)

ftonato commented 8 years ago

Segue o PR @filipedeschamps =)