Skip to content

Commit

Permalink
Add changelog link
Browse files Browse the repository at this point in the history
  • Loading branch information
elreco committed Sep 7, 2022
1 parent 31c00bd commit c2a8bf1
Show file tree
Hide file tree
Showing 11 changed files with 173 additions and 51 deletions.
128 changes: 128 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
12 changes: 12 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# These are supported funding model platforms

github: elreco
patreon: # Replace with a single Patreon username
open_collective:
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
11 changes: 0 additions & 11 deletions CHANGELOG.md

This file was deleted.

44 changes: 13 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,40 +16,22 @@ Go to [full documentation](https://vue-tailwind-datepicker.com)
How it works,

```vue
<script setup>
import { ref } from 'vue'
import VueTailwindDatepicker from 'vue-tailwind-datepicker'
const dateValue = ref([])
const formatter = ref({
date: 'DD MMM YYYY',
month: 'MMM'
})
</script>
<template>
<div>
<vue-tailwind-datepicker
ref="myRef"
:formatter="formatter"
v-model="dateValue"
/>
<vue-tailwind-datepicker :formatter="formatter" v-model="dateValue" />
</div>
</template>
<script>
import { ref } from 'vue';
import VueTailwindDatepicker from 'vue-tailwind-datepicker';
export default {
components: {
VueTailwindDatepicker
},
setup() {
const myRef = ref(null);
const dateValue = ref([]);
const formatter = ref({
date: 'DD MMM YYYY',
month: 'MMM'
});
return {
myRef,
dateValue,
formatter
};
}
};
</script>
```

## Theming options
Expand All @@ -63,7 +45,7 @@ export default {
![Dark Mode](https://github.com/elreco/vue-tailwind-datepicker/blob/main/docs/dark.png?raw=true)

## Changelog
All notable changes to this project will be documented in this file, [Read](CHANGELOG.md).
All notable changes to this project will be documented in the [Releases Page](https://github.com/elreco/vue-tailwind-datepicker/releases).

## License
The [MIT](LICENSE) License. Please [see](http://opensource.org/licenses/MIT) for more information.
Expand Down
13 changes: 12 additions & 1 deletion docs/.vitepress/config.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { version } from '../../package.json'

export default {
title: 'Vue Tailwind Datepicker',
description: 'Components, composables and configurations for Vue 3',
Expand Down Expand Up @@ -28,7 +30,16 @@ export default {
nav: [
{ text: 'Home', link: '/' },
{ text: 'Get Started', link: '/installation' },
{ text: 'Demo', link: '/demo' }
{ text: 'Demo', link: '/demo' },
{
text: version,
items: [
{
text: 'Changelog',
link: 'https://github.com/elreco/vue-tailwind-datepicker/releases'
},
]
}
]
}
}
2 changes: 1 addition & 1 deletion docs/advanced-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ const customShortcuts = () => {

## Localization (i18n)

Litepie Datepicker extend to day.js<br>
Vue Tailwind Datepicker extend to day.js<br>
[List of supported locales](https://github.com/iamkun/dayjs/tree/dev/src/locale)

<DemoLayout>
Expand Down
2 changes: 1 addition & 1 deletion docs/demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# Demo

::: tip
You can also test it with [the playground](https://stackblitz.com/edit/vuepic-vue-datepicker-pkdbxu?file=src/components/Playground.vue)!
You can also test it with [the playground](https://stackblitz.com/edit/vue-tailwind-datepicker?file=src/components/Playground.vue)!
:::

<DemoLayout>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ hero:
link: https://github.com/elreco/vue-tailwind-datepicker
- theme: alt
text: Playground
link: https://stackblitz.com/edit/vuepic-vue-datepicker-pkdbxu?file=src/components/Playground.vue
link: https://stackblitz.com/edit/vue-tailwind-datepicker?file=src/components/Playground.vue
features:
- icon: ⚡️
title: Powerful
Expand Down
4 changes: 2 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
## Install via npm

```
$ npm install -S litepie-datepicker
$ npm install vue-tailwind-datepicker
```

## Install via yarn

```
$ yarn add litepie-datepicker
$ yarn add vue-tailwind-datepicker
```

## How it works
Expand Down
4 changes: 2 additions & 2 deletions docs/props.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ const dateValue = ref([])
<template>
<div class="flex">
<litepie-datepicker
<vue-tailwind-datepicker
v-model="dateValue"
v-slot="{ value, placeholder, clear }"
>
Expand Down Expand Up @@ -415,7 +415,7 @@ const dateValue = ref([])
</button>
</div>
</div>
</litepie-datepicker>
</vue-tailwind-datepicker>
</div>
</template>
```
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "vue-tailwind-datepicker",
"description": "A date range picker component for Vue.js 3 using Tailwind CSS",
"version": "0.0.1",
"version": "1.0.0",
"files": [
"dist"
],
Expand Down

1 comment on commit c2a8bf1

@vercel
Copy link

@vercel vercel bot commented on c2a8bf1 Sep 7, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.