diff --git a/README.md b/README.md
index 12a678e31..15905f1fc 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@
-[](https://github.com/doocs/md/actions) [](https://nodejs.org/en/about/previous-releases) [](https://github.com/doocs/md/releases) [](./LICENSE) [](https://github.com/doocs/md/pulls)
[](https://github.com/doocs/md/stargazers) [](https://github.com/doocs/md)
+[](https://github.com/doocs/md/actions) [](https://nodejs.org/en/about/previous-releases) [](https://github.com/doocs/md/pulls) [](https://github.com/doocs/md/stargazers) [](https://github.com/doocs/md)
[](https://github.com/doocs/md/releases) [](https://www.npmjs.com/package/@doocs/md-cli) [](https://hub.docker.com/r/doocs/md)
@@ -78,19 +78,19 @@ Markdown 文档自动即时渲染为微信图文,让你不再为微信文章
示例代码:
```js
-const { file, util, okCb, errCb } = CUSTOM_ARG
-const param = new FormData()
-param.append(`file`, file)
+const { file, util, okCb, errCb } = CUSTOM_ARG;
+const param = new FormData();
+param.append(`file`, file);
util.axios
.post(`http://127.0.0.1:9000/upload`, param, {
- headers: { 'Content-Type': `multipart/form-data` },
+ headers: { "Content-Type": `multipart/form-data` },
})
.then((res) => {
- okCb(res.url)
+ okCb(res.url);
})
.catch((err) => {
- errCb(err)
- })
+ errCb(err);
+ });
// 提供的可用参数:
// CUSTOM_ARG = {
diff --git a/md-cli/README.md b/md-cli/README.md
new file mode 100644
index 000000000..24a81f23d
--- /dev/null
+++ b/md-cli/README.md
@@ -0,0 +1,50 @@
+# md-cli
+
+A powerful yet simple tool for rendering Markdown documents locally during development.
+
+## Installation
+
+To get started with `md-cli`, you can install it either globally or locally, depending on your needs.
+
+### Install locally
+
+If you only need it for a specific project, you can install it locally by running:
+
+```bash
+npm install @doocs/md-cli
+```
+
+### Install globally
+
+For global access across all your projects, install it globally with:
+
+```bash
+npm install -g @doocs/md-cli
+```
+
+## Usage
+
+Once installed, running `md-cli` is a breeze. Here’s how to get started:
+
+### Default setup
+
+To launch `md-cli` with the default settings, simply run:
+
+```bash
+md-cli
+```
+
+### Custom port
+
+If you prefer to run `md-cli` on a different port, say `8899`, just specify it like this:
+
+```bash
+md-cli port=8899
+```
+
+## Maintainers
+
+- [yanglbme](https://github.com/yanglbme) – Core contributor.
+- [YangFong](https://github.com/yangfong) – Core maintainer.
+- [xw](https://github.com/wll8) – Contributor.
+- [thinkasany](https://www.npmjs.com/~thinkerwing) – Contributor.