diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index a524fd4..ba16e78 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -31,6 +31,9 @@ export default defineConfigWithTheme({ { text: 'What is vue-vnode-utils?', link: '/guide/introduction.html' + }, { + text: 'Installation', + link: '/guide/installation.html' } ] } diff --git a/docs/guide/installation.md b/docs/guide/installation.md new file mode 100644 index 0000000..c1d9ccc --- /dev/null +++ b/docs/guide/installation.md @@ -0,0 +1,54 @@ +# Installation + +## npm + +Installation with `npm`/`yarn`/`pnpm`: + +```sh +npm add @skirtle/vue-vnode-utils +``` + +ES module usage: + +```js +import { addProps } from '@skirtle/vue-vnode-utils' +``` + +## CDN - global build + +```html + +``` + +This should be placed after the ` + +``` + +As with the global build, this should be changed to an exact version and switched to `.prod` in production. + +Some browsers do not yet have full support for import maps.