-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Se actualizó y mejoró la documentación 😎
- Loading branch information
Showing
2 changed files
with
86 additions
and
50 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
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 |
---|---|---|
@@ -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 |