summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLi Zhineng <[email protected]>2025-04-29 07:13:04 +0800
committerGitHub <[email protected]>2025-04-29 07:13:04 +0800
commit58f2c3fcf011bce7523b9c459ac472410cab6753 (patch)
tree5b921fd1bbe5f5cc2eb9fb2c72b53335181ebe90 /README.md
parent7e3e7ef53f62edb7a3ea6b38a37cbdd843c50909 (diff)
parent9378e811cb845086e4334cc62c5e242502d45ecb (diff)
downloadregion-china-58f2c3fcf011bce7523b9c459ac472410cab6753.tar.gz
region-china-58f2c3fcf011bce7523b9c459ac472410cab6753.zip
Merge pull request #2 from lizhineng/readme-install
Installment information
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index f7c22bf..1374951 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,15 @@ annually based on information from the _Ministry of Civil Affairs of
the People's Republic of China_. The latest update was applied on
[April 25, 2025](https://www.mca.gov.cn/mzsj/xzqh/2025/202401xzqh.html).
+## Installment
+
+The library requires a minimum of PHP 8.4 and can be installed through
+[Composer](https://getcomposer.org):
+
+```bash
+composer require lizhineng/region-china
+```
+
## Usage
The library includes built-in data sourced directly from the authority,