iran-cities/README.md

The most accurate database of city, county and province names of Iran

# iran-cities
The most accurate database of city, county and province names of Iran for Node.js - Thanks To github.com/ahmadazizi

## Requirements

Make sure all dependencies have been installed:

* [Node.js](http://nodejs.org/) >= 6.10.x
* [NPM](https://www.npmjs.com/) OR [YARN](https://yarnpkg.com/en/docs/install)

## Install

* `npm install iran-cities`

## Usage

```
const cities = require('iran-cities');

let city = cities.getCity(); // return cities names
let county = cities.getCounty(); // return counties names
let province = cities.getProvince(); // return provinces names

cities.convertToJson() // for development purposes - convert CSV to JSON
```