瀏覽代碼

Update README.md

modood 8 年之前
父節點
當前提交
726dc0b8f9
共有 1 個文件被更改,包括 60 次插入0 次删除
  1. 60 0
      README.md

+ 60 - 0
README.md

@@ -2,6 +2,12 @@
 
 中华人民共和国行政区划:省份、城市、区县、乡镇(街道)
 
+[![npm](https://img.shields.io/npm/v/china-division.svg)](https://www.npmjs.com/package/china-division)
+[![npm](https://img.shields.io/npm/dt/china-division.svg)](https://www.npmjs.com/package/china-division)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/modood/Administrative-divisions-of-China/master/LICENSE)
+
+## JSON
+
 | 文件列表                                     | 格式化         | 压缩版      |
 |:---------------------------------------------|:---------------| :-----------|
 | 省份数据                                     | [provinces.json](https://github.com/modood/Administrative-divisions-of-China/blob/master/dist/provinces.json) | [provinces.min.json](https://github.com/modood/Administrative-divisions-of-China/blob/master/dist/provinces.min.json) |
@@ -12,3 +18,57 @@
 | “省、市、区” 三级联动数据                    | [address3.json](https://github.com/modood/Administrative-divisions-of-China/blob/master/dist/address3.json) | [address3.min.json](https://github.com/modood/Administrative-divisions-of-China/blob/master/dist/address3.min.json) |
 | “省、市、区、镇” 四级联动数据                | [address4.json](https://github.com/modood/Administrative-divisions-of-China/blob/master/dist/address4.json) | [address4.min.json](https://github.com/modood/Administrative-divisions-of-China/blob/master/dist/address4.min.json) |
 
+## NPM(不建议)
+
+> 注意:
+
+> 由于获取数据为同步操作,出于性能考虑,不建议使用 Node 模块这种方式使用。
+
+> 建议 [下载 JSON 文件](https://github.com/modood/Administrative-divisions-of-China/tree/master/dist)
+> 然后在代码里使用 require 引入,原因参考 [Node.js Modules](https://nodejs.org/dist/latest-v4.x/docs/api/modules.html)。
+
+安装:
+
+```
+$ npm install --save china-division
+```
+
+使用:
+
+```js
+var chinaDivision = require('china-division');
+
+// 省份数据
+var provinces = chinaDivision.provinces;
+
+// 城市数据
+var cities = chinaDivision.cities;
+
+// 区县数据
+var areas = chinaDivision.areas;
+
+// 乡镇(街道)数据
+var streets = chinaDivision.streets;
+
+// “省、市” 二级联动数据
+var address2 = chinaDivision.address2;
+
+// “省、市、区” 三级联动数据
+var address3 = chinaDivision.address3;
+
+// “省、市、区、镇” 四级联动数据
+var address4 = chinaDivision.address4;
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+this repo is released under the [MIT License](http://www.opensource.org/licenses/MIT).
+