Skip to content

Commit

Permalink
Se actualizó y mejoró la documentación 😎
Browse files Browse the repository at this point in the history
  • Loading branch information
jobsamuel committed Sep 29, 2015
1 parent f1ede99 commit 1000a3e
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 50 deletions.
67 changes: 66 additions & 1 deletion DOCUMENTACION.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,71 @@
## instalación

Puedes instalar **venezuela-js** globalmente para utilizarlo en la terminal.

```bash
$ npm install -g venezuela
```

También puedes instalarlo localmente para utilizarlo sólo en tu proyecto.


```bash
$ npm install venezuela
```

## uso

#### global (en tu terminal)


```bash
$ venezuela Zulia
```

![Estado](http://i.imgur.com/LciVjJf.png)

#### local

Ejemplo.js
```js
var venezuela = require('venezuela');

var mcbo = venezuela.municipio('Maracaibo');

console.log(mcbo);
```

El resultado será algo así

```json
{
"municipio": "Maracaibo",
"capital": "Maracaibo",
"estado": "Zulia",
"parroquias": [
"Antonio Borjas Romero",
"Bolívar",
"Cacique Mara",
"Carracciolo Parra Pérez",
"Cecilio Acosta",
"Cristo de Aranza",
"Coquivacoa",
"Chiquinquirá",
"Francisco Eugenio Bustamante",
"Idelfonzo Vásquez",
"Juana de Ávila",
"Luis Hurtado Higuera",
"Manuel Dagnino",
"Olegario Villalobos.",
"Raúl Leoni",
"Santa Lucía",
"Venancio Pulgar",
"San Isidro"
]
}
```

## propiedades

### venezuela.pais
Expand Down Expand Up @@ -146,4 +207,8 @@ El resultado será:
"estado": "Distrito Capital"
}
]
```
```

# licencia

Licencia [MIT](http://opensource.org/licenses/MIT) :copyright: Jobsamuel Núñez
69 changes: 20 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,29 @@
# venezuela-js [![npm version](https://badge.fury.io/js/venezuela.svg)](http://badge.fury.io/js/venezuela) [![npm](https://img.shields.io/npm/dt/venezuela.svg)]() [![npm](https://img.shields.io/npm/l/venezuela.svg)]()

> Analiza, verifica, utiliza y muestra la organización territorial de Venezuela con Javascript.
# instalación

```bash
$ npm install venezuela
```
<p align="center">
<img alt="venezuela-js" src="http://i.imgur.com/9CNl0Af.pngg" width="auto">
</p>
<p align="center" style="color:#707070;">
Muestra la organización territorial de Venezuela.
</p>
<p align="center">
<a href="http://badge.fury.io/js/venezuela"><img alt="version" src="https://badge.fury.io/js/venezuela.svg"></a>
<a href="https://www.npmjs.com/package/venezuela"><img alt="descargas" src="https://img.shields.io/npm/dt/venezuela.svg"></a>
<a href="http://badge.fury.io/js/venezuela"><img alt="dependencias" src="https://david-dm.org/jobsamuel/venezuela-js.svg"></a>
<a href="https://www.npmjs.com/package/venezuela"><img alt="licencia" src="https://img.shields.io/npm/l/venezuela.svg"></a>
</p>

----

# uso

Ejemplo.js
```js
var venezuela = require('venezuela');

var mcbo = venezuela.municipio('Maracaibo');

console.log(mcbo);
```

El resultado será algo así

```json
{
"municipio": "Maracaibo",
"capital": "Maracaibo",
"estado": "Zulia",
"parroquias": [
"Antonio Borjas Romero",
"Bolívar",
"Cacique Mara",
"Carracciolo Parra Pérez",
"Cecilio Acosta",
"Cristo de Aranza",
"Coquivacoa",
"Chiquinquirá",
"Francisco Eugenio Bustamante",
"Idelfonzo Vásquez",
"Juana de Ávila",
"Luis Hurtado Higuera",
"Manuel Dagnino",
"Olegario Villalobos.",
"Raúl Leoni",
"Santa Lucía",
"Venancio Pulgar",
"San Isidro"
]
}
```bash
$ npm install -g venezuela
$ venezuela --ayuda
```

# api
# documentación

[Documentación del API de venezuela-js](DOCUMENTACION.md)
[Documentación del API](DOCUMENTACION.md)

# licencia

Licencia [MIT](http://opensource.org/licenses/MIT) :copyright: Jobsamuel Núñez
Licencia [MIT](http://opensource.org/licenses/MIT) :copyright: Jobsamuel Núñez

0 comments on commit 1000a3e

Please sign in to comment.