docs: chinese readme

README-CN.md

@@ -0,0 +1,71 @@
+# Gungnir
+
+[![npm](https://img.shields.io/npm/v/vuepress-theme-gungnir.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/vuepress-theme-gungnir) [![docs](https://img.shields.io/badge/Docs-Gungnir-26A2FF?style=flat-square&logo=read-the-docs&logoColor=ffffff)](https://github.com/Renovamen/vuepress-theme-gungnir) [![license](https://img.shields.io/badge/License-Apache--2.0-green?style=flat-square)](LICENSE)
+
+一个基于 [VuePress](https://vuepress.vuejs.org/) 的博客主题。同时[这里](https://github.com/Renovamen/jekyll-theme-gungnir)还有一个它的 [Jekyll](https://jekyllrb.com/) 版本。
+
+**Gungnir**，冈格尼尔，北欧神话中主神奥丁使用的用世界树树枝做成的武器，和本主题没有半毛钱关系但我就是用了这个名字。
+
+🇬🇧 [English Intro](README.md) | 🇨🇳 中文说明
+
+![preview](example/.vuepress/public/img/docs/gungnir.jpg)
+
+
+ 
+
+## 特性
+
+- 简洁美观（反正这点我说是就是了）
+- 响应式
+- 多级目录
+- 可切换的首页大图
+- 明亮和夜间模式：识别系统的外观设置并自动切换模式，也支持用户手动切换
+- 搜索
+- 文章目录
+- 代码高亮渲染，支持代码块全屏（从 WordPress 主题 [Sakura](https://github.com/mashirozx/Sakura) 搬过来的功能）
+- 基于 [Katex](https://github.com/KaTeX/KaTeX) 的公式支持
+- 在文章中使用图表：[Chart.js](https://www.chartjs.org)、[Mermaid](https://mermaid-js.github.io) 和 [roughViz.js](https://github.com/jwilber/roughViz)
+- 文章中的一些附加样式，目前支持：
+  - 脚注（基于 [markdown-it-footnote](https://github.com/markdown-it/markdown-it-footnote)）
+  - 高亮（基于 [markdown-it-mark](https://github.com/markdown-it/markdown-it-mark)）
+- 站点统计（[Google Analytics](https://analytics.google.com/) 和 [百度统计](https://tongji.baidu.com/)）
+- 评论（基于 [Vssue](https://github.com/meteorlxy/vssue)）
+- RSS
+- 阅读时间估计
+- 多语言支持（英文、简体中文）
+- 带标签的归档页、链接页
+
+
+ 
+
+## 安装
+
+```bash
+yarn add -D vuepress-theme-gungnir
+# or
+npm i -D vuepress-theme-gungnir
+```
+
+
+ 
+
+## 演示站点
+
+这里有一些演示站点：
+
+- [vuepress-theme-gungnir.vercel.app](https://vuepress-theme-gungnir.vercel.app/)
+- [renovamen.ink](https://renovamen.ink)（我的博客）
+
+
+ 
+
+## 文档
+
+[这里](https://vuepress-theme-gungnir.vercel.app/docs/)是本主题的（正在施工中的）文档。
+
+
+ 
+
+## 开源协议
+
+Gungnir 主题遵守 [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) 开源协议，详细细节见 [LICENSE](packages/theme-gungnir/LICENSE) 文件。

README.md

@@ -1,12 +1,41 @@
 # Gungnir
 
-This is an ongoing VuePress version of the blog theme Gungnir. The Jekyll version of it is available [here](https://github.com/Renovamen/jekyll-theme-gungnir).
+[![npm](https://img.shields.io/npm/v/vuepress-theme-gungnir.svg?style=flat-square&logo=npm)](https://www.npmjs.com/package/vuepress-theme-gungnir) [![docs](https://img.shields.io/badge/Docs-Gungnir-26A2FF?style=flat-square&logo=read-the-docs&logoColor=ffffff)](https://github.com/Renovamen/vuepress-theme-gungnir) [![license](https://img.shields.io/badge/License-Apache--2.0-green?style=flat-square)](LICENSE)
+
+A blog theme for [VuePress](https://vuepress.vuejs.org/). The [Jekyll](https://jekyllrb.com/) version of it is available [here](https://github.com/Renovamen/jekyll-theme-gungnir).
 
 **Gungnir** is the spear of the god Odin in Norse mythology.
 
+🇬🇧 English Intro | 🇨🇳 [中文说明](README-CN.md)
+
 ![preview](example/.vuepress/public/img/docs/gungnir.jpg)
 
 
+ 
+
+## Features
+
+- Simple and beautiful
+- Responsive design
+- Multi-level navigation
+- Switchable cover images for home page
+- Dark and light mode: system theme detection with a theme-switcher to set the theme as per the user preference
+- Search
+- Table of contents
+- Syntax highlighting, support full screening the code blocks (inspired by WordPress theme [Sakura](https://github.com/mashirozx/Sakura))
+- Tex support ([Katex](https://github.com/KaTeX/KaTeX))
+- Draw charts in Markdown easily: [Chart.js](https://www.chartjs.org), [Mermaid](https://mermaid-js.github.io) and [roughViz.js](https://github.com/jwilber/roughViz)
+- Markdown enhancements:
+  - Footnote ([markdown-it-footnote](https://github.com/markdown-it/markdown-it-footnote))
+  - Mark ([markdown-it-mark](https://github.com/markdown-it/markdown-it-mark))
+- Analytics ([Google Analytics](https://analytics.google.com/) and [Baidu Tongji](https://tongji.baidu.com/))
+- Comment ([Vssue](https://github.com/meteorlxy/vssue))
+- RSS
+- Reading time
+- Multi-language support (English, Simplified Chinese)
+- Archive page with tags, links page
+
+
  
 
 ## Installation
@@ -28,6 +57,13 @@ Here are some live demos:
 - [renovamen.ink](https://renovamen.ink) (my blog)
 
 
+ 
+
+## Documentation
+
+Documentation is available (but ongoing) [here](https://vuepress-theme-gungnir.vercel.app/docs/).
+
+
  
 
 ## License