From 984069530e1e311adb2e59a1913d2664f166fc50 Mon Sep 17 00:00:00 2001
From: Yu Cong <sxlxcsxlxc@gmail.com>
Date: Tue, 6 Jan 2026 22:06:22 +0800
Subject: [PATCH] add readme. remove changelog

---
 CHANGELOG.md      |  5 -----
 README.md         | 11 +++++++++++
 panguFilter.cabal |  2 +-
 3 files changed, 12 insertions(+), 6 deletions(-)
 delete mode 100644 CHANGELOG.md
 create mode 100644 README.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
deleted file mode 100644
index b37569c..0000000
--- a/CHANGELOG.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# Revision history for panguFilter
-
-## 0.1.0.0 -- YYYY-mm-dd
-
-* First version. Released on an unsuspecting world.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..883f98b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# pangu.hs
+
+Insert whitespace between CJK and half-width characters.
+
+This haskell version implements a subset of spacing rules in [pangu.py](https://github.com/vinta/pangu.py).
+
+## test
+
+```sh
+cabal test
+```
\ No newline at end of file
diff --git a/panguFilter.cabal b/panguFilter.cabal
index 41be4c8..f4c1f15 100644
--- a/panguFilter.cabal
+++ b/panguFilter.cabal
@@ -46,7 +46,7 @@ category:           Text
 build-type:         Simple
 
 -- Extra doc files to be distributed with the package, such as a CHANGELOG or a README.
-extra-doc-files:    CHANGELOG.md
+-- extra-doc-files:    CHANGELOG.md
 
 -- Extra source files to be distributed with the package, such as examples, or a tutorial module.
 -- extra-source-files: