aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/README.md b/README.md
index cf3430e..09f19cb 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
<p align="center">
<a href="https://github.com/CatilGrass/mingling">
- <img alt="Mingling" src="res/icon_shadow.png" width="30%">
+ <img alt="Mingling" src="docs/res/icon_shadow.png" width="30%">
</a>
</p>
<h1 align="center">Mìng Lìng - 命令</h1>
@@ -38,7 +38,10 @@
## Intro
-`Mingling` is a Rust command-line framework. Its name comes from the Chinese Pinyin for "命令", which means "Command".
+[`Mingling`](https://github.com/CatilGrass/mingling) is a **proc-macro and type system-based** Rust CLI framework, suitable for developing complex command-line programs with numerous subcommands.
+
+> BTW: Its name comes from the Chinese Pinyin "mìng lìng", meaning "Command". 😄
+
## Quick Start
@@ -102,7 +105,7 @@ Mingling abstracts command execution into the following parts:
<summary>Architecture Diagram (click to expand)</summary>
<p align="center">
<a href="https://github.com/CatilGrass/mingling">
- <img alt="Mingling" src="res/graph.png" width="75%">
+ <img alt="Mingling" src="docs/res/graph.png" width="75%">
</a>
</p>
</details>