v-calendar-3 1.0.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2017 Nathan Reyes
+
+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.

package/README.md

@@ -0,0 +1,142 @@
+# VCalendar Plugin for Vue 3.5.16+
+
+A calendar and date picker plugin for [Vue.js](https://vuejs.org).
+
+[Vue.js](https://vuejs.org) 3.2+, [Popper.js](https://popper.js.org/docs/v2/) 2.0+ are required.
+
+## Install Plugin
+
+### NPM
+
+```shell
+npm install v-calendar-3 @popperjs/core
+```
+
+### Yarn
+
+```shell
+yarn add v-calendar-3 @popperjs/core
+```
+
+## Use Plugin
+
+:warning: **As of `v3.0.0-alpha.7`, all installation methods require manual import of component styles. This is due to Vite build restrictions in libary mode.**
+
+```js
+import 'v-calendar-3/style.css';
+```
+
+### Method 1: Use Globally
+
+```js
+import VCalendar from 'v-calendar-3';
+import 'v-calendar-3/style.css';
+
+// Use plugin with optional defaults
+app.use(VCalendar, {})
+```
+
+```html
+<!-- MyComponent.vue -->
+<template>
+  <VCalendar />
+  <VDatePicker v-model="date" />
+</template>
+```
+
+### Method 2: Use Components Globally
+
+```js
+// main.js
+import { setupCalendar, Calendar, DatePicker } from 'v-calendar-3';
+import 'v-calendar-3/style.css';
+
+// Use plugin defaults (optional)
+app.use(setupCalendar, {})
+
+// Use the components
+app.component('VCalendar', Calendar)
+app.component('VDatePicker', DatePicker)
+```
+
+```html
+<!-- MyComponent.vue -->
+<template>
+  <VCalendar />
+  <VDatePicker v-model="date" />
+</template>
+```
+
+### Method 3: Use Components As Needed
+
+```js
+// main.js
+import { setupCalendar } from 'v-calendar-3';
+
+// Use calendar defaults (optional)
+app.use(setupCalendar, {})
+```
+
+```vue
+<!-- MyComponent.vue -->
+<template>
+  <Calendar />
+  <DatePicker v-model="date">
+</template>
+
+<script>
+import { Calendar, DatePicker } from 'v-calendar-3';
+import 'v-calendar-3/style.css';
+
+export default {
+  components: {
+    Calendar,
+    DatePicker,
+  },
+  data() {
+    return {
+      date: new Date(),
+    };
+  },
+}
+</script>
+```
+
+## Source setup
+
+Please follow below mentioned steps to clone and build this project:
+
+### Clone the repo
+
+```sh
+git clone https://github.com/BEJIbXEOP/v-calendar
+
+# Move to directory
+cd v-calendar
+```
+
+### Install dependencies
+
+```sh
+yarn
+```
+
+### Build library
+
+```sh
+# Types, ES, ESM, CommonJS, IIFE
+yarn build
+```
+
+### Lint and fix files
+
+```sh
+yarn lint
+```
+
+### Test library
+
+```sh
+# Types, ES, ESM, CommonJS, IIFE
+yarn test
+```