Skip to content

Commit a6873b7

Browse files
committed
Add links to the documentation
1 parent 20bfd70 commit a6873b7

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ A command-line utility for scaffolding a Vite project to build a Vue-based libra
44

55
⚠️ This is currently work-in-progress. It is not yet usable.
66

7+
Documentation: <https://skirtles-code.github.io/create-vue-lib/>
8+
79
## Thanks
810

911
This project is inspired by the official [create-vue](https://github.com/vuejs/create-vue) scaffolding tool and wouldn't be possible without it. Many thanks to [Haoqun Jiang](https://github.com/haoqunjiang) for all the hard work he puts in to maintaining that project.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"license": "MIT",
66
"description": "Create a library using Vue and Vite",
77
"keywords": ["vue", "library", "scaffold", "vite", "build"],
8-
"homepage": "https://github.com/skirtles-code/create-vue-lib#readme",
8+
"homepage": "https://skirtles-code.github.io/create-vue-lib/",
99
"bugs": "https://github.com/skirtles-code/create-vue-lib/issues",
1010
"repository": {
1111
"type": "git",

src/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,6 @@ type Args = {
8383
extended: boolean
8484
}
8585

86-
// TODO: Add link to docs
8786
const helpMessage = `\
8887
Usage: create-vue-lib [OPTIONS...]
8988
@@ -96,6 +95,8 @@ Options:
9695
Display this help message.
9796
--version, -v
9897
Display the version number for create-vue-lib.
98+
99+
Full documentation at https://skirtles-code.github.io/create-vue-lib/
99100
`
100101

101102
function processArgs(): Args {

0 commit comments

Comments
 (0)