Skip to content

Commit

Permalink
docs: add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
viko16 committed Feb 2, 2019
1 parent 0e1e116 commit 70001e8
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,29 @@
# vuepress-theme-simple

[![npm](https://img.shields.io/npm/v/vuepress-theme-simple.svg)](https://www.npmjs.com/package/vuepress-theme-simple)
[![LICENSE](https://img.shields.io/npm/l/vuepress-theme-simple.svg)](https://github.com/sqrthree/vuepress-theme-simple/blob/master/LICENSE)
[![Dependency Status](https://david-dm.org/viko16/vuepress-theme-simple.svg?theme=shields.io)](https://david-dm.org/viko16/vuepress-theme-simple)

> ✏️ Very simple blog theme for VuePress.
![preview](https://user-images.githubusercontent.com/5064777/52162728-51198680-2713-11e9-9546-e737600be782.png)

## Installation

```shell
$ npm install vuepress-theme-simple --save
```

## Usage

Modify your `.vuepress/config.js` and provide the `theme` option.

```js
module.exports = {
theme: 'simple',
}
```

## License

[MIT License](https://opensource.org/licenses/MIT) © [viko16](https://github.com/viko16)
9 changes: 9 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
{
"name": "vuepress-theme-simple",
"description": "✏️ simple blog theme for VuePress",
"version": "0.1.0",
"main": "index.js",
"scripts": {
"lint": "eslint .",
"release": "npm run lint && standard-version && npm publish"
},
"keywords": [
"vuepress",
"vuepress-theme",
"blog-theme"
],
"author": "viko16 <16viko@gmail.com>",
"repository": "viko16/vuepress-theme-simple",
"license": "MIT",
"devDependencies": {
"eslint": "^5.13.0",
"eslint-plugin-vue": "^5.1.0",
Expand Down

0 comments on commit 70001e8

Please sign in to comment.