# Mage2 Module Stemcell ChineseDirectory

    ``stemcell/module-chinesedirectory``

 - [Main Functionalities](#markdown-header-main-functionalities)
 - [Installation](#markdown-header-installation)
 - [Configuration](#markdown-header-configuration)
 - [Specifications](#markdown-header-specifications)
 - [Attributes](#markdown-header-attributes)


## Main Functionalities
address for chinese administrative division

## Installation
\* = in production please use the `--keep-generated` option

### Type 1: Zip file

 - Unzip the zip file in `app/code/Stemcell`
 - Enable the module by running `php bin/magento module:enable Stemcell_ChineseDirectory`
 - Apply database updates by running `php bin/magento setup:upgrade`\*
 - Flush the cache by running `php bin/magento cache:flush`

### Type 2: Composer

 - Make the module available in a composer repository for example:
    - private repository `repo.magento.com`
    - public repository `packagist.org`
    - public github repository as vcs
 - Add the composer repository to the configuration by running `composer config repositories.repo.magento.com composer https://repo.magento.com/`
 - Install the module composer by running `composer require stemcell/module-chinesedirectory`
 - enable the module by running `php bin/magento module:enable Stemcell_ChineseDirectory`
 - apply database updates by running `php bin/magento setup:upgrade`\*
 - Flush the cache by running `php bin/magento cache:flush`


## Configuration




## Specifications




## Attributes

 - CustomerAddress - City (city_id)

 - CustomerAddress - District (district_id)

 - CustomerAddress - District (district)

 - CustomerAddress - Town (town_id)

 - CustomerAddress - Town (town)

 - Sales - City (city_id)

 - Sales - District (district_id)

 - Sales - District (district)

 - Sales - Town (town_id)

 - Sales - Town (town)

 - Sales - Town (town_Id)