From 1355bd580de56b0d6aa873121f30ee91b7d46d2d Mon Sep 17 00:00:00 2001 From: pengzhanbo Date: Sat, 6 Jan 2024 00:17:21 +0800 Subject: [PATCH] docs: update readme --- readme.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index c2925c07..1b48de81 100644 --- a/readme.md +++ b/readme.md @@ -2,11 +2,11 @@ 一个简约的 vuepress 主题。 -开箱即用,仅需少量配置即可使用。 +开箱即用,仅需少量配置即可使用,让您更专注于 内容的创作。 [![npm version](https://img.shields.io/npm/v/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=npm)](https://www.npmjs.com/package/vuepress-theme-plume) [![npm beta download](https://img.shields.io/npm/dt/@vuepress-plume/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=beta%20downloads)](https://www.npmjs.com/package/vuepress-theme-plume) -[![npm download](https://img.shields.io/npm/dy/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=downloads)](https://www.npmjs.com/package/vuepress-theme-plume) +[![npm download](https://img.shields.io/npm/dm/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=downloads)](https://www.npmjs.com/package/vuepress-theme-plume) ![GitHub License](https://img.shields.io/github/license/pengzhanbo/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A) ### [查看文档](https://pengzhanbo.cn/note/vuepress-theme-plume) @@ -14,11 +14,11 @@ ## Install ``` sh -npm install vuepress@next vuepress-theme-plume +npm install vue vuepress@next vuepress-theme-plume # or -pnpm add vuepress@next vuepress-theme-plume +pnpm add vue vuepress@next vuepress-theme-plume # or -yarn add vuepress@next vuepress-theme-plume +yarn add vue vuepress@next vuepress-theme-plume ``` ## Usage @@ -28,8 +28,9 @@ import { defineUserConfig } from 'vuepress' import { plumeTheme } from 'vuepress-theme-plume' export default defineUserConfig({ + // vuepress config... theme: plumeTheme({ - // theme config + // theme config... }) }) ```