Skip to content
This repository was archived by the owner on May 13, 2024. It is now read-only.

Commit bff142f

Browse files
committed
chore: readme
1 parent f103ce9 commit bff142f

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
1-
# vuepress-theme-blogging
1+
# @vuepress/theme-blog
22

3-
[![NPM version](https://badgen.net/npm/v/vuepress-theme-blogging)](https://npmjs.com/package/vuepress-theme-blogging) [![NPM downloads](https://badgen.net/npm/dm/vuepress-theme-blogging)](https://npmjs.com/package/vuepress-theme-blogging) [![CircleCI](https://badgen.net/circleci/github/ulivz/vuepress-theme-blogging/master)](https://circleci.com/gh/ulivz/vuepress-theme-blogging/tree/master)
3+
[![NPM version](https://badgen.net/npm/v/@vuepress/theme-blog)](https://npmjs.com/package/@vuepress/theme-blog) [![NPM downloads](https://badgen.net/npm/dm/@vuepress/theme-blog)](https://npmjs.com/package/@vuepress/theme-blog) [![CircleCI](https://badgen.net/circleci/github/ulivz/@vuepress/theme-blog/master)](https://circleci.com/gh/ulivz/@vuepress/theme-blog/tree/master)
44

55
## Install
66

77
```bash
8-
npm i vuepress-theme-blogging
8+
yarn add @vuepress/theme-blog -D
9+
# OR npm install @vuepress/theme-blog -D
910
```
1011

1112
## Usage
1213

1314
```js
14-
const vuepressThemeBlogging = require('vuepress-theme-blogging')
15-
16-
vuepressThemeBlogging()
17-
//=> foo
15+
// .vuepress/config.js
16+
module.exports = {
17+
theme: '@vuepress/blog',
18+
themeConfig: {
19+
// Please head documentation to see the available options.
20+
}
21+
}
1822
```
1923

2024
## Contributing
@@ -28,8 +32,7 @@ vuepressThemeBlogging()
2832

2933
## Author
3034

31-
**vuepress-theme-blogging** © [ULIVZ](https://github.com/ulivz), Released under the [MIT](./LICENSE) License.<br>
32-
35+
**@vuepress/theme-blog** © [ULIVZ](https://github.com/ulivz), Released under the [MIT](./LICENSE) License.<br>
3336

3437
> [github.com/ulivz](https://github.com/ulivz) · GitHub [@ULIVZ](https://github.com/ulivz) · Twitter [@_ulivz](https://twitter.com/_ulivz)
3538

0 commit comments

Comments
 (0)