Skip to content

Commit 1ba3e17

Browse files
committed
docs: update readmes and license
1 parent 1478760 commit 1ba3e17

File tree

3 files changed

+41
-44
lines changed

3 files changed

+41
-44
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) ULIVZ <[email protected]> (https://github.com/ulivz)
3+
Copyright (c) Ben Hong <[email protected]> (https://github.com/bencodezen)
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README copy.md

-42
This file was deleted.

README.md

+40-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,40 @@
1-
# create-vuepress-site
1+
# create-vuepress-site
2+
3+
Scaffolding a VuePress project
4+
5+
[![NPM version](https://badgen.net/npm/v/create-vuepress-site)](https://npmjs.com/package/create-vuepress-site) [![NPM downloads](https://badgen.net/npm/dm/create-vuepress-site)](https://npmjs.com/package/create-vuepress-site)
6+
7+
## Usage
8+
9+
> Note that you need to initialize this instruction in an empty directory.
10+
11+
```shell
12+
# npm
13+
$ npx create-vuepress-site [appName]
14+
15+
# yarn
16+
$ yarn create vuepress-site [appName]
17+
```
18+
19+
Please be sure to `cd [appName]` and run `yarn` to install dependencies.
20+
21+
## Boilerplates
22+
23+
- `docs` - Create a documentation project with VuePress.
24+
- `blog` - Create a blog project with VuePress.
25+
26+
## Contributing
27+
28+
1. Fork it!
29+
2. Create your feature branch: `git checkout -b my-new-feature`
30+
3. Commit your changes: `git commit -am 'Add some feature'`
31+
4. Push to the branch: `git push origin my-new-feature`
32+
5. Submit a pull request :D
33+
34+
## Hat Tip
35+
36+
`create-vuepress-site` exists due to the previous work of:
37+
38+
- [create-vuepress](https://github.com/vuepressjs/create-vuepress)
39+
40+
- [create-umi](https://github.com/umijs/create-umi) (Direct reuse of scaffolding functions of the library.)

0 commit comments

Comments
 (0)