update README [ci skip]

CTeX-org · Sep 16, 2017 · 4959d2a · 4959d2a
1 parent e8b0779
commit 4959d2a
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -4,10 +4,19 @@
 [![CTAN](https://img.shields.io/ctan/v/zhlipsum.svg)](https://www.ctan.org/pkg/zhlipsum)
 [![GitHub release](https://img.shields.io/github/release/Stone-Zeng/zhlipsum/all.svg)](https://github.com/Stone-Zeng/zhlipsum/releases/latest)
 
-Basic usage:
+## Introduction
 
-    \zhlipsum[3]
-    \zhlipsum*[1-5]
+This package provides an interface to dummy text in Chinese, which
+will be useful for testing Chinese documents.
+
+`zhlipsum` supports both UTF-8 and GBK encoding.
+
+## Basic usage
+
+```tex
+\zhlipsum[3]
+\zhlipsum*[1-5]
+```
 
 More information can be found in the package documentation
 [zhlipsum.pdf](http://mirrors.ctan.org/macros/latex/contrib/zhlipsum/zhlipsum.pdf).

diff --git a/source/zhlipsum.dtx b/source/zhlipsum.dtx
@@ -37,12 +37,21 @@
 [![CTAN](https://img.shields.io/ctan/v/zhlipsum.svg)](https://www.ctan.org/pkg/zhlipsum)
 [![GitHub release](https://img.shields.io/github/release/Stone-Zeng/zhlipsum/all.svg)](https://github.com/Stone-Zeng/zhlipsum/releases/latest)
 
-Basic usage:
+## Introduction
 
-    \zhlipsum[3]
-    \zhlipsum*[1-5]
+This package provides an interface to dummy text in Chinese, which
+will be useful for testing Chinese documents.
 
-More information can be found in the package documentation 
+`zhlipsum` supports both UTF-8 and GBK encoding.
+
+## Basic usage
+
+```tex
+\zhlipsum[3]
+\zhlipsum*[1-5]
+```
+
+More information can be found in the package documentation
 [zhlipsum.pdf](http://mirrors.ctan.org/macros/latex/contrib/zhlipsum/zhlipsum.pdf).
 
 ## License