Merge pull request #10 from healerlab/features/docs

feat: update license

Author: HealerNguyen

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 HealerLab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,5 +1,12 @@
 # Vue 3 simple OTP input
 
+[![npm](https://img.shields.io/npm/v/@healerlab/vue3-simple-otp-input?style=flat-square)](https://www.npmjs.com/package/@healerlab/vue3-simple-otp-input)
+[![npm](https://img.shields.io/npm/dw/@healerlab/vue3-simple-otp-input?style=flat-square)](https://www.npmjs.com/package/@healerlab/vue3-simple-otp-input)
+[![GitHub](https://img.shields.io/github/license/healerlab/vue3-simple-otp-input?style=flat-square)](https://github.com/healerlab/vue3-simple-otp-input/blob/main/LICENSE)
+
+## Demo
+[Demo and docs](https://healerlab.github.io/vue3-simple-otp-input)
+
 ## Installation
 
 ### Prerequisites

deploy.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env sh
+
+# abort on errors
+set -e
+
+# build
+yarn docs:build
+
+# navigate into the build output directory
+cd docs/.vitepress/dist
+
+# if you are deploying to a custom domain
+# echo 'www.example.com' > CNAME
+
+git init
+git add -A
+git commit -m 'deploy'
+
+# if you are deploying to https://<USERNAME>.github.io
+# git push -f git@github.com:<USERNAME>/<USERNAME>.github.io.git master
+
+# if you are deploying to https://<USERNAME>.github.io/<REPO>
+git push -f git@github.com:healerlab/vue3-simple-otp-input.git main:gh-pages
+
+cd -

docs/.vitepress/config.ts

@@ -2,7 +2,7 @@ import { defineConfig } from 'vitepress'
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  base: '/',
+  base: '/vue3-simple-otp-input/',
   lang: "en-US",
   lastUpdated: true,
   cleanUrls: true,