├── README.md ├── header.png ├── portuguese └── README.md └── spanish └── README.md /README.md: -------------------------------------------------------------------------------- 1 | # Product Name 2 | > Short blurb about what your product does. 3 | 4 | [![NPM Version][npm-image]][npm-url] 5 | [![Build Status][travis-image]][travis-url] 6 | [![Downloads Stats][npm-downloads]][npm-url] 7 | 8 | One to two paragraph statement about your product and what it does. 9 | 10 | ![](header.png) 11 | 12 | ## Installation 13 | 14 | OS X & Linux: 15 | 16 | ```sh 17 | npm install my-crazy-module --save 18 | ``` 19 | 20 | Windows: 21 | 22 | ```sh 23 | edit autoexec.bat 24 | ``` 25 | 26 | ## Usage example 27 | 28 | A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots. 29 | 30 | _For more examples and usage, please refer to the [Wiki][wiki]._ 31 | 32 | ## Development setup 33 | 34 | Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms. 35 | 36 | ```sh 37 | make install 38 | npm test 39 | ``` 40 | 41 | ## Release History 42 | 43 | * 0.2.1 44 | * CHANGE: Update docs (module code remains unchanged) 45 | * 0.2.0 46 | * CHANGE: Remove `setDefaultXYZ()` 47 | * ADD: Add `init()` 48 | * 0.1.1 49 | * FIX: Crash when calling `baz()` (Thanks @GenerousContributorName!) 50 | * 0.1.0 51 | * The first proper release 52 | * CHANGE: Rename `foo()` to `bar()` 53 | * 0.0.1 54 | * Work in progress 55 | 56 | ## Meta 57 | 58 | Your Name – [@YourTwitter](https://twitter.com/dbader_org) – YourEmail@example.com 59 | 60 | Distributed under the XYZ license. See ``LICENSE`` for more information. 61 | 62 | [https://github.com/yourname/github-link](https://github.com/dbader/) 63 | 64 | ## Contributing 65 | 66 | 1. Fork it () 67 | 2. Create your feature branch (`git checkout -b feature/fooBar`) 68 | 3. Commit your changes (`git commit -am 'Add some fooBar'`) 69 | 4. Push to the branch (`git push origin feature/fooBar`) 70 | 5. Create a new Pull Request 71 | 72 | 73 | [npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square 74 | [npm-url]: https://npmjs.org/package/datadog-metrics 75 | [npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square 76 | [travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square 77 | [travis-url]: https://travis-ci.org/dbader/node-datadog-metrics 78 | [wiki]: https://github.com/yourname/yourproject/wiki 79 | -------------------------------------------------------------------------------- /header.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dbader/readme-template/f89960a33fc952bcfe811675540347dfb361a6d5/header.png -------------------------------------------------------------------------------- /portuguese/README.md: -------------------------------------------------------------------------------- 1 | # Nome do produto 2 | > Descrição curta sobre o que seu projeto faz. 3 | 4 | [![NPM Version][npm-image]][npm-url] 5 | [![Build Status][travis-image]][travis-url] 6 | [![Downloads Stats][npm-downloads]][npm-url] 7 | 8 | De um a dois parágrafos sobre o que é seu projeto e o que ele faz. 9 | 10 | ![](../header.png) 11 | 12 | ## Instalação 13 | 14 | OS X & Linux: 15 | 16 | ```sh 17 | npm install my-crazy-module --save 18 | ``` 19 | 20 | Windows: 21 | 22 | ```sh 23 | edit autoexec.bat 24 | ``` 25 | 26 | ## Exemplo de uso 27 | 28 | Alguns exemplos interessantes e úteis sobre como seu projeto pode ser utilizado. Adicione blocos de códigos e, se necessário, screenshots. 29 | 30 | _Para mais exemplos, consulte a [Wiki][wiki]._ 31 | 32 | ## Configuração para Desenvolvimento 33 | 34 | Descreva como instalar todas as dependências para desenvolvimento e como rodar um test-suite automatizado de algum tipo. Se necessário, faça isso para múltiplas plataformas. 35 | 36 | ```sh 37 | make install 38 | npm test 39 | ``` 40 | 41 | ## Histórico de lançamentos 42 | 43 | * 0.2.1 44 | * MUDANÇA: Atualização de docs (código do módulo permanece inalterado) 45 | * 0.2.0 46 | * MUDANÇA: Remove `setDefaultXYZ()` 47 | * ADD: Adiciona `init()` 48 | * 0.1.1 49 | * CONSERTADO: Crash quando chama `baz()` (Obrigado @NomeDoContribuidorGeneroso!) 50 | * 0.1.0 51 | * O primeiro lançamento adequado 52 | * MUDANÇA: Renomeia `foo()` para `bar()` 53 | * 0.0.1 54 | * Trabalho em andamento 55 | 56 | ## Meta 57 | 58 | Seu Nome – [@SeuNome](https://twitter.com/...) – SeuEmail@exemplo.com 59 | 60 | Distribuído sob a licença XYZ. Veja `LICENSE` para mais informações. 61 | 62 | [https://github.com/yourname/github-link](https://github.com/othonalberto/) 63 | 64 | ## Contributing 65 | 66 | 1. Faça o _fork_ do projeto () 67 | 2. Crie uma _branch_ para sua modificação (`git checkout -b feature/fooBar`) 68 | 3. Faça o _commit_ (`git commit -am 'Add some fooBar'`) 69 | 4. _Push_ (`git push origin feature/fooBar`) 70 | 5. Crie um novo _Pull Request_ 71 | 72 | [npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square 73 | [npm-url]: https://npmjs.org/package/datadog-metrics 74 | [npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square 75 | [travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square 76 | [travis-url]: https://travis-ci.org/dbader/node-datadog-metrics 77 | [wiki]: https://github.com/seunome/seuprojeto/wiki 78 | -------------------------------------------------------------------------------- /spanish/README.md: -------------------------------------------------------------------------------- 1 | # Nombre de producto 2 | > Breve descripción de lo que hace tu producto. 3 | 4 | [![NPM Version][npm-image]][npm-url] 5 | [![Build Status][travis-image]][travis-url] 6 | [![Downloads Stats][npm-downloads]][npm-url] 7 | 8 | Uno o dos párrafos sobre tu producto y el problema que resuelve. 9 | 10 | ![](../header.png) 11 | 12 | ## Instalación 13 | 14 | OS X y Linux: 15 | 16 | ```sh 17 | npm install my-crazy-module --save 18 | ``` 19 | 20 | Windows: 21 | 22 | ```sh 23 | edit autoexec.bat 24 | ``` 25 | 26 | ## Ejemplo de uso 27 | 28 | Algunos casos de ejemplo sobre cómo utilizar tu producto. Algunos bloques de código y capturas de pantalla harán que sea más atractivo. 29 | 30 | ## Configuración de desarrollo 31 | 32 | Describe como instalar todas las dependencias y como ejecutar la batería de tests (en caso de tenerla). Si funciona en múltiples plataformas intenta describirlas todas si tuviesen pasos diferentes. 33 | 34 | ```sh 35 | make install 36 | npm test 37 | ``` 38 | 39 | ## Historial de versiones 40 | 41 | * 0.2.1 42 | * CAMBIO: Actualizada la documentación (el módulo de código permanece igual) 43 | * 0.2.0 44 | * CAMBIO: Eliminado `setDefaultXYZ()` 45 | * AÑADIDO: Añadido `init()` 46 | * 0.1.1 47 | * ARREGLADO: Cuelgue cuando se llama a `baz()` (Gracias a @NombreDelAmableContribuidor!) 48 | * 0.1.0 49 | * La primera release 50 | * CAMBIO: Renombrado `foo()` a `bar()` 51 | * 0.0.1 52 | * Trabajo en progreso 53 | 54 | ## Meta 55 | 56 | Tu nomre – [@TuTwitter](https://twitter.com/dbader_org) – TuEmail@example.com 57 | 58 | Distribuido bajo la licencia XYZ. Ver ``LICENSE`` para más información. 59 | 60 | [https://github.com/yourname/github-link](https://github.com/dbader/) 61 | 62 | [npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square 63 | [npm-url]: https://npmjs.org/package/datadog-metrics 64 | [npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square 65 | [travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square 66 | [travis-url]: https://travis-ci.org/dbader/node-datadog-metrics 67 | --------------------------------------------------------------------------------