📝 Docs: update README for usage

hugo-fixit · Jan 9, 2025 · 0781670 · 0781670
1 parent b124218
commit 0781670
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,10 @@
 ![Hugo Theme FixIt](https://fixit.lruihao.cn/images/apple-devices-preview.png)
 
 <div align="center" class="ignore">
-  <p>FixIt is a clean, elegant but advanced blog theme for <a href="https://gohugo.io/">Hugo</a>.</p>
+  <p>
+    FixIt is a clean, elegant but advanced blog theme for <a href="https://gohugo.io/">Hugo</a>.<br>
+    <em><sub>Don't forget to leave a ⭐️ if you like this theme, thanks!</sub></em>
+  </p>
   English |
   <a href="/README.zh-cn.md">简体中文</a> |
   <a href="https://fixit.lruihao.cn/zh-cn/ecosystem/hugo-fixit/fixit/?lang=chinese_traditional">繁體中文</a> |
@@ -35,13 +38,31 @@
   More FixIt examples <a href="https://fixit.lruihao.cn/showcase/">here</a>.
 </p>
 
-## Documentation
+## Why choose FixIt
+
+I don't know why 🤷.
+
+<!-- Too lazy to write... -->
+
+## Usage
+
+### Documentation
 
 Head to the [Quick Start](https://fixit.lruihao.cn/documentation/getting-started/quick-start/) page for a step-by-step guide on how to create a new website with FixIt.
 
 Outline: [Installation](https://fixit.lruihao.cn/documentation/installation/) ➜ [Getting Started](https://fixit.lruihao.cn/documentation/getting-started/) ➜ [Content Management](https://fixit.lruihao.cn/documentation/content-management/) ➜ [Advanced Usage](https://fixit.lruihao.cn/documentation/advanced/)
 
-## Template repository
+### Starter Wizard
+
+We provided a CLI tool to help you create a new project with FixIt by a single command.
+
+```bash
+pnpx fixit-cli create my-blog
+```
+
+[![asciicast](https://asciinema.org/a/697494.svg)](https://asciinema.org/a/697494)
+
+### Templates
 
 Click the following links to generate a new repository with template:
 
@@ -61,12 +82,6 @@ Click the following links to generate a new repository with template:
 [lruihao-blog]: https://github.com/Lruihao/hugo-blog
 [lruihao-blog:generate]: https://github.com/Lruihao/hugo-blog/generate
 
-## Why choose FixIt
-
-I don't know why 🤷
-
-<!-- Too lazy to write... -->
-
 ## Features
 
 ### Performance and SEO
@@ -189,8 +204,6 @@ All feedback is welcome! Head over to the [discussions][discussions], [Pull requ
 | [FixIt QQ group][qq-group]  | QQ group: `814031017`           |
 | [Hugo FixIt Planet][zsxq]   | Paid knowledge Planet           |
 
-Don't forget to leave a ⭐️ if you like this theme, thanks!
-
 [discussions]: https://github.com/hugo-fixit/FixIt/discussions
 [pulls]: https://github.com/hugo-fixit/FixIt/pulls
 [issues]: https://github.com/hugo-fixit/FixIt/issues

diff --git a/README.zh-cn.md b/README.zh-cn.md
@@ -2,7 +2,10 @@
 ![Hugo Theme FixIt](https://fixit.lruihao.cn/images/apple-devices-preview.png)
 
 <div align="center" class="ignore">
-  <p>FixIt 是一个简洁、优雅且高效的 <a href="https://gohugo.io/">Hugo</a> 博客主题。</p>
+  <p>
+    FixIt 是一个简洁、优雅且高效的 <a href="https://gohugo.io/">Hugo</a> 博客主题。<br>
+    <em><sub>如果你喜欢这个主题，别忘了留下一颗 ⭐️ 哦，谢谢！</sub></em>
+  </p>
   <a href="/README.md">English</a> |
   简体中文 |
   <a href="https://fixit.lruihao.cn/zh-cn/ecosystem/hugo-fixit/fixit/?lang=chinese_traditional">繁體中文</a> |
@@ -35,13 +38,31 @@
   更多 FixIt 的例子参见 <a href="https://fixit.lruihao.cn/zh-cn/showcase/">这里</a>。
 </p>
 
-## 主题文档
+## 为什么选择 FixIt
+
+我也不知道为什么 🤷。
+
+<!-- 懒的写…… -->
+
+## 使用指南
+
+### 主题文档
 
 前往 [快速上手](https://fixit.lruihao.cn/zh-cn/documentation/getting-started/quick-start/) 页面，了解如何使用 FixIt 主题创建一个新网站的详细步骤。
 
 大纲：[安装篇](https://fixit.lruihao.cn/zh-cn/documentation/installation/) ➜ [入门篇](https://fixit.lruihao.cn/zh-cn/documentation/getting-started/) ➜ [内容管理](https://fixit.lruihao.cn/zh-cn/documentation/content-management/) ➜ [进阶篇](https://fixit.lruihao.cn/zh-cn/documentation/advanced/)
 
-## 模板仓库
+### 快速开始
+
+我们提供了一个 CLI 工具，可以通过一个命令来创建一个新的 FixIt 项目。
+
+```bash
+pnpx fixit-cli create my-blog
+```
+
+[![asciicast](https://asciinema.org/a/697494.svg)](https://asciinema.org/a/697494)
+
+### 模板
 
 点击以下链接使用模板生成一个新的仓库：
 
@@ -61,11 +82,9 @@
 [lruihao-blog]: https://github.com/Lruihao/hugo-blog
 [lruihao-blog:generate]: https://github.com/Lruihao/hugo-blog/generate
 
-## 为什么选择 FixIt
-
-我也不知道为什么 🤷
+### 镜像
 
-<!-- 懒的写…… -->
+Gitee 镜像仓库：<https://gitee.com/lruihao/FixIt>
 
 ## 特性
 
@@ -178,10 +197,6 @@ FixIt 支持下列语言：
 
 [语言兼容性](https://fixit.lruihao.cn/zh-cn/theme-documentation-basics/#language-compatibility)
 
-## 镜像
-
-Gitee 镜像仓库：<https://gitee.com/lruihao/FixIt>
-
 ## 社区支持
 
 所有的反馈都是欢迎的！详见 [Discussions][discussions]、[Pull requests][pulls] 和 [Issues][issues]。
@@ -193,8 +208,6 @@ Gitee 镜像仓库：<https://gitee.com/lruihao/FixIt>
 | [FixIt 主题交流群（QQ）][qq-group] | QQ 群：`814031017`              |
 | [Hugo FixIt 星球][zsxq]            | 付费知识星球                    |
 
-如果你喜欢这个主题，别忘了留下一颗 ⭐️ 哦，谢谢！
-
 [discussions]: https://github.com/hugo-fixit/FixIt/discussions
 [pulls]: https://github.com/hugo-fixit/FixIt/pulls
 [issues]: https://github.com/hugo-fixit/FixIt/issues