From 563273fc331ca41138319524bd71760e998b964f Mon Sep 17 00:00:00 2001
From: geekifan <i@ifan.dev>
Date: Mon, 28 Apr 2025 12:19:32 +0800
Subject: [PATCH] update README

---
 README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 60 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 85d8bcf..38a13db 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,60 @@
-# WIP: hugo-theme-chirpy
\ No newline at end of file
+<!-- markdownlint-disable-next-line -->
+<div align="center">
+
+  <!-- markdownlint-disable-next-line -->
+  # Chirpy Hugo Theme
+
+  A minimal, responsive, and feature-rich Jekyll theme for technical writing.
+
+  [**Live Demo** →][demo] | [**Jekyll Theme** →][chirpy-jekyll]
+
+  [![Devices Mockup](https://chirpy-img.netlify.app/commons/devices-mockup.png)][demo]
+
+</div>
+
+## Features
+
+- Native i18n Support (thanks to [Hugo][hugo])
+- Dark Theme
+- Localized UI language
+- Pinned Posts on Home Page
+- Hierarchical Categories
+- Trending Tags
+- Table of Contents
+- Last Modified Date
+- Syntax Highlighting (🚧 Work in Progress)
+- Mathematical Expressions
+- Mermaid Diagrams & Flowcharts (🚧 Work in Progress)
+- Dark Mode Images
+- Embed Media
+- Comment Systems (🙋‍♂️ Call for Test)
+- Built-in Search
+- RSS Feeds
+- PWA (🚧 Work in Progress)
+- Web Analytics
+- SEO & Performance Optimization
+
+## Documentation
+
+To learn how to use, develop, and upgrade the project, please refer to the [Wiki][wiki].
+
+## Contributing
+
+Contributions (_pull requests_, _issues_, and _discussions_) are what make the open-source community such an amazing place
+to learn, inspire, and create. Any contributions you make are greatly appreciated.
+For details, see the "[Contributing Guidelines][contribute-guide]".
+
+## Credits
+
+Thanks to the theme [Chirpy Jekyll Theme][chirpy-jekyll] and all its contributors.
+
+## License
+
+This project is published under [MIT License][license].
+
+[chirpy-jekyll]: https://github.com/cotes2020/jekyll-theme-chirpy
+[license]: https://github.com/geekifan/hugo-theme-chirpy/blob/main/LICENSE
+[hugo]: https://gohugo.io/
+[demo]: https://github.com/geekifan/
+[wiki]: https://github.com/geekifan/
+[contribute-guide]: https://github.com/geekifan/
\ No newline at end of file