refactor(README)!: Rewrite README (#454)

* refactor(README)!: Rewrite README

* chore(README): Format with prettier

* chore(README): Update links

* chore(doc): This is the right place for me

* chore(README): Adjust font size

* chore(README): Add line-break

* chore(README): Rephrase

* chore(README): Bold targets

README.md

@@ -1,46 +1,192 @@
-# Introduction
+<h1 align="center">
+    nvimdots
+    <br>
+    <a href="https://github.com/neovim/neovim/releases/tag/stable">
+    <img
+        alt="NeoVim Version Capability"
+        src="https://img.shields.io/badge/Supports%20Nvim-v0.8-A6D895?style=for-the-badge&colorA=363A4F&logo=neovim&logoColor=D9E0EE">
+    </a>
+    <a href="https://github.com/ayamir/nvimdots/releases">
+    <img
+        alt="Release"
+        src="https://img.shields.io/github/v/release/ayamir/nvimdots.svg?style=for-the-badge&logo=github&color=F2CDCD&logoColor=D9E0EE&labelColor=363A4F">
+    </a>
+</h1>
+
+<p align="center">
+    <a href="https://github.com/ayamir/nvimdots/stargazers">
+    <img
+        alt="Stars"
+        src="https://img.shields.io/github/stars/ayamir/nvimdots?colorA=363A4F&colorB=B7BDF8&logo=adafruit&style=for-the-badge">
+    </a>
+    <a href="https://github.com/ayamir/nvimdots/issues">
+    <img
+        alt="Issues"
+        src="https://img.shields.io/github/issues-raw/ayamir/nvimdots?colorA=363A4f&colorB=F5A97F&logo=github&logoColor=D9E0EE&style=for-the-badge">
+    </a>
+    <a href="https://github.com/ayamir/nvimdots/contributors">
+    <img
+        alt="Contributors"
+        src="https://img.shields.io/github/contributors/ayamir/nvimdots?colorA=363A4F&colorB=A6DA95&logo=git&logoColor=D9E0EE&style=for-the-badge">
+    </a>
+    <img
+        alt="Code Size"
+        src="https://img.shields.io/github/languages/code-size/ayamir/nvimdots?colorA=363A4F&colorB=DDB6F2&logo=gitlfs&logoColor=D9E0EE&style=for-the-badge">
+</p>
+
+## 🪷 Introduction
+
+This repo hosts my [NeoVim](https://neovim.io/) configuration for Linux, macOS, and Windows. `init.lua` is the config entry point.
+
+It contains two branches:
+| Branch | Completion Solution |
+| :----: | :------------------------: |
+| main | config for nvim 0.8 stable |
+| 0.7 | config for nvim 0.7 stable |
 
-![Dashboard](https://raw.githubusercontent.com/ayamir/blog-imgs/main/dashboard.png)
+I use [lazy.nvim](https://github.com/folke/lazy.nvim) to manage plugins.
 
-![Telescope](https://raw.githubusercontent.com/ayamir/blog-imgs/main/telescope.png)
+Chinese introduction is [here](https://zhuanlan.zhihu.com/p/382092667).
 
-![Coding](https://raw.githubusercontent.com/ayamir/blog-imgs/main/coding.png)
+### 🎐 Features
+
+- **Fast.** Less than **30ms** to start (Depends on SSD and CPU, tested on Zephyrus G14 2022 version).
+- **Simple.** Run out of the box.
+- **Modern.** Pure `lua` config.
+- **Modular.** Easy to customize.
+- **Powerful.** Full functionality to code.
+
+## 🏗 How to Install
+
+Just run the following interactive bootstrap command, and you're good to go 👍
+
+- **Windows** _(Note: This script REQUIRES `pwsh` > `v7.1`)_
+
+```pwsh
+Set-ExecutionPolicy Bypass -Scope Process -Force; Invoke-WebRequest 'https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/install/install.ps1' | Invoke-Expression
+```
+
+- **\*nix**
+
+```sh
+if command -v curl >/dev/null 2>&1; then
+    bash -c "$(curl -fsSL https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/install/install.sh)"
+else
+    bash -c "$(wget -O- https://raw.githubusercontent.com/ayamir/nvimdots/HEAD/install/install.sh)"
+fi
+```
+
+It's strongly recommended to read [Wiki: Prerequisites](https://github.com/ayamir/nvimdots/wiki/Prerequisites) before starting, especially for \*nix users.
 
-![Debuging](https://raw.githubusercontent.com/ayamir/blog-imgs/main/dap.png)
+## ⚙️ Configuration & Usage
 
-![Lazygit](https://raw.githubusercontent.com/ayamir/blog-imgs/main/gitui.png)
+<h3 align="center">
+    🗺️ Keybindings
+</h3>
+<p align="center">Refer to <a href="https://github.com/ayamir/nvimdots/wiki/Keybindings" rel="nofollow">Wiki: Keybindings</a></p>
+<br>
 
-![Legendary](https://raw.githubusercontent.com/ayamir/blog-imgs/main/legendary.png)
+<h3 align="center">
+    🔌 Plugins & Deps
+</h3>
+<p align="center">Refer to <a href="https://github.com/ayamir/nvimdots/wiki/Plugins" rel="nofollow">Wiki: Plugins</a> <br><em>(You can also find a deps diagram there!)</em></p>
+<br>
 
-This is my neovim's configuration, which contains two branches.
+<h3 align="center">
+    🔧 Usage & Customization
+</h3>
+<p align="center">Refer to <a href="https://github.com/ayamir/nvimdots/wiki/Usage" rel="nofollow">Wiki: Usage</a></p>
+<br>
 
-I use [lazy.nvim](https://github.com/folke/lazy.nvim) to manage plugins.
+<h3 align="center">
+    🤔 FAQ
+</h3>
+<p align="center">Refer to <a href="https://github.com/ayamir/nvimdots/wiki/Issues" rel="nofollow">Wiki: FAQ</a></p>
 
-| Branch |    Completion Solution     |
-| :----: | :------------------------: |
-|  main  | config for nvim 0.8 stable |
-|  0.7   | config for nvim 0.7 stable |
+## ✨ Features
 
-Chinese introduction is [here](https://zhuanlan.zhihu.com/p/382092667).
+<h3 align="center">
+    ⏱️  Startup Time
+</h3>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ayamir/blog-imgs/main/startuptime.png"
+  width = "80%"
+  alt = "StartupTime"
+  />
+</p>
 
-**Pros**:
+<p align="center">
+  <img src="https://raw.githubusercontent.com/ayamir/blog-imgs/main/vimstartup.png"
+  width = "60%"
+  alt = "Vim-StartupTime"
+  />
+</p>
 
--   Fast. Less than **30ms** to start (Depends on SSD and CPU, tested on Zephyrus G14 2022 version).
--   Simple. Run out of the box.
--   Modern. Pure lua to config.
--   Modular. Easy to customize.
--   Powerful. Full functionality to code.
+> Tested with [rhysd/vim-startuptime](https://github.com/rhysd/vim-startuptime)
 
-![startup time](https://raw.githubusercontent.com/ayamir/blog-imgs/main/startuptime.png)
+<h3 align="center">
+    📸 Screenshots
+</h3>
 
-![vim-startuptime](https://raw.githubusercontent.com/ayamir/blog-imgs/main/vimstartup.png)
+<p align="center">
+    <img src="https://raw.githubusercontent.com/ayamir/blog-imgs/main/dashboard.png" alt="Dashboard">
+    <em>Dashboard</em>
+</p>
+<br>
 
-(Tested with [rhysd/vim-startuptime](https://github.com/rhysd/vim-startuptime))
+<p align="center">
+    <img src="https://raw.githubusercontent.com/ayamir/blog-imgs/main/telescope.png" alt="Telescope">
+    <em>Telescope</em>
+</p>
+<br>
 
-# Details
+<p align="center">
+    <img src="https://raw.githubusercontent.com/ayamir/blog-imgs/main/coding.png" alt="Coding">
+    <em>Coding</em>
+</p>
+<br>
 
-Please **make sure** to follow [wiki](https://github.com/ayamir/nvimdots/wiki) to install.
+<p align="center">
+    <img src="https://raw.githubusercontent.com/ayamir/blog-imgs/main/dap.png" alt="Debugging">
+    <em>Debugging</em>
+</p>
+<br>
 
-# Acknowledgement
+<p align="center">
+    <img src="https://raw.githubusercontent.com/ayamir/blog-imgs/main/gitui.png" alt="Lazygit">
+    <em>Lazygit with built-in Terminal</em>
+</p>
+<br>
+
+<p align="center">
+    <img src="https://raw.githubusercontent.com/ayamir/blog-imgs/main/legendary.png" alt="Legendary">
+    <em>Command quickref</em>
+</p>
+
+## 👐 Contributing
+
+- If you find anything that needs improving, do not hesitate to point it out or create a PR.
+- If you come across an issue, you can first use `:checkhealth` command provided by nvim to trouble-shoot yourself.
+  - If you still have such problems, feel free to open a new issue!
+
+## ❤️ Thanks to
+
+- [ayamir](https://github.com/ayamir)
+- [Jint-lzxy](https://github.com/Jint-lzxy)
+- [CharlesChiuGit](https://github.com/CharlesChiuGit)
 
--   [glepnir/nvim](https://github.com/glepnir/nvim)
+## 🎉 Acknowledgement
+
+- [glepnir/nvim](https://github.com/glepnir/nvim)
+
+## 📜 License
+
+This NeoVim configuration is released under the MIT license, which grants the following permissions:
+
+- Commercial use
+- Distribution
+- Modification
+- Private use
+
+For more convoluted language, see the [LICENSE](https://github.com/ayamir/nvimdots/blob/main/LICENSE).