diff --git a/README.md b/README.md index 3f3b9c3..4a3ab4f 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,234 @@ # Vue HTML to Paper -Vue 3 plugin for printing html elements. +Vue plugin for printing html elements. ![npm](https://img.shields.io/npm/dw/vue-html-to-paper) -### Vue 3 - [Demo](https://mycurelabs.github.io/vue-html-to-paper/) [GitBook Documentation](https://oss.mycure.md/v/vue-html-to-paper/) +## Install + +```sh +npm install vue-html-to-paper +yarn add vue-html-to-paper +``` + +## Development Setup + +``` +npm install + +npm run build:all +``` + +## Usage + +### Vue 3, Vue 2 +- initialize in `main.ts|js` (optional) +- use in component: +```js +