Skip to content

Commit

Permalink
fix(readme): add Eng version readme
Browse files Browse the repository at this point in the history
  • Loading branch information
imgarylai committed May 2, 2020
1 parent b3f6015 commit 3e7cad5
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,21 @@
[![Build Status](https://travis-ci.org/imgarylai/use-tw-zipcode.svg?branch=master)](https://travis-ci.org/imgarylai/use-tw-zipcode)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

## 簡介
## Intro 簡介

可以簡單的需要製作台灣縣市、行政區下拉式選單,並取得郵遞區號,只處理邏輯的部分,所以可以很簡單的用於各種 CSS 版型。
可以簡單的需要製作台灣縣市、行政區下拉式選單,並取得郵遞區號,只處理邏輯的部分,所以可以很簡單的用於各種 CSS 版型。

## 安裝
Taiwanese zip code, 3 digits style, is determined by two factors, city and district. It is usually not necessary to ask users to fill the zip code by themselves. It is nicer if you are building an interface capturing zip code automatically once they fill in the field, city, and district. And a dropdown menu is commonly used for this scenario.

This library aims to help you create a user-friendly dropdown menu without any CSS/style framework dependency by using React hook. You can find examples below. Let's build an excellent user interface together! 🙌🏻

## Installation 安裝

```bash
npm install use-tw-zipcode
```

## 範例
## Example 範例

```jsx
import React from "react";
Expand Down Expand Up @@ -51,12 +55,14 @@ export default function App() {

```

## 其他範例
## Other examples 其他範例

[MATERIAL-UI](https://material-ui.com/) 一起使用

This example shows how to work with CSS framework. In this example, it comes with [MATERIAL-UI](https://material-ui.com/).

[![Edit use-tw-zipcode](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/use-tw-zipcode-w5y6q?autoresize=1&fontsize=14&hidenavigation=1&theme=dark)

## Demo
## Live Demo

[https://use-tw-zipcode.now.sh/](https://use-tw-zipcode.now.sh/)

0 comments on commit 3e7cad5

Please sign in to comment.