forked from dbader/readme-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Nombre de producto | ||
> Breve descripción de lo que hace tu producto. | ||
[![NPM Version][npm-image]][npm-url] | ||
[![Build Status][travis-image]][travis-url] | ||
[![Downloads Stats][npm-downloads]][npm-url] | ||
|
||
Uno o dos párrafos sobre tu producto y el problema que resuelve. | ||
|
||
![](../header.png) | ||
|
||
## Instalación | ||
|
||
OS X y Linux: | ||
|
||
```sh | ||
npm install my-crazy-module --save | ||
``` | ||
|
||
Windows: | ||
|
||
```sh | ||
edit autoexec.bat | ||
``` | ||
|
||
## Ejemplo de uso | ||
|
||
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. | ||
|
||
## Configuración de desarrollo | ||
|
||
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. | ||
|
||
```sh | ||
make install | ||
npm test | ||
``` | ||
|
||
## Historial de versiones | ||
|
||
* 0.2.1 | ||
* CAMBIO: Actualizada la documentación (el módulo de código permanece igual) | ||
* 0.2.0 | ||
* CAMBIO: Eliminado `setDefaultXYZ()` | ||
* AÑADIDO: Añadido `init()` | ||
* 0.1.1 | ||
* ARREGLADO: Cuelgue cuando se llama a `baz()` (Gracias a @NombreDelAmableContribuidor!) | ||
* 0.1.0 | ||
* La primera release | ||
* CAMBIO: Renombrado `foo()` a `bar()` | ||
* 0.0.1 | ||
* Trabajo en progreso | ||
|
||
## Meta | ||
|
||
Tu nomre – [@TuTwitter](https://twitter.com/dbader_org) – [email protected] | ||
|
||
Distribuido bajo la licencia XYZ. Ver ``LICENSE`` para más información. | ||
|
||
[https://github.com/yourname/github-link](https://github.com/dbader/) | ||
|
||
[npm-image]: https://img.shields.io/npm/v/datadog-metrics.svg?style=flat-square | ||
[npm-url]: https://npmjs.org/package/datadog-metrics | ||
[npm-downloads]: https://img.shields.io/npm/dm/datadog-metrics.svg?style=flat-square | ||
[travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square | ||
[travis-url]: https://travis-ci.org/dbader/node-datadog-metrics |