Skip to content

Commit

Permalink
docs: update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
abichinger committed Nov 14, 2024
1 parent e3ef97f commit ab66cdb
Show file tree
Hide file tree
Showing 8 changed files with 28 additions and 23 deletions.
1 change: 1 addition & 0 deletions ant/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<a href="https://www.npmjs.com/package/@vue-js-cron/ant">Ant</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/element-plus">Element Plus</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/naive-ui">Naive UI</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/prime">PrimeVue</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/quasar">Quasar</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
</p>
Expand Down
1 change: 1 addition & 0 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<a href="https://www.npmjs.com/package/@vue-js-cron/ant">Ant</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/element-plus">Element Plus</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/naive-ui">Naive UI</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/prime">PrimeVue</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/quasar">Quasar</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
</p>
Expand Down
1 change: 1 addition & 0 deletions element-plus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<a href="https://www.npmjs.com/package/@vue-js-cron/ant">Ant</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/element-plus">Element Plus</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/naive-ui">Naive UI</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/prime">PrimeVue</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/quasar">Quasar</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
</p>
Expand Down
1 change: 1 addition & 0 deletions light/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<a href="https://www.npmjs.com/package/@vue-js-cron/ant">Ant</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/element-plus">Element Plus</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/naive-ui">Naive UI</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/prime">PrimeVue</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/quasar">Quasar</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
</p>
Expand Down
1 change: 1 addition & 0 deletions naive-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<a href="https://www.npmjs.com/package/@vue-js-cron/ant">Ant</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/element-plus">Element Plus</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/naive-ui">Naive UI</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/prime">PrimeVue</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/quasar">Quasar</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
</p>
Expand Down
44 changes: 21 additions & 23 deletions prime/README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
# @vue-js-cron/prime
![Vue.js Cron Vuetify Hero](https://raw.githubusercontent.com/abichinger/vue-js-cron/main/assets/vue-js-cron-hero.png)

This template should help get you started developing with Vue 3 in Vite.
<p align="center">
<em>generate cron expressions using vue.js</em>
</p>

## Recommended IDE Setup
<p align="center">
<a href="https://www.npmjs.com/package/@vue-js-cron/core">Core</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/light">Light</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/ant">Ant</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/element-plus">Element Plus</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/naive-ui">Naive UI</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/prime">PrimeVue</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/quasar">Quasar</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
</p>

[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
## Links - PrimeVue

## Type Support for `.vue` Imports in TS
[Demo](https://abichinger.github.io/vue-js-cron/demo.html)

TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
[Get Started](https://abichinger.github.io/vue-js-cron/guide/getting-started-prime)

## Customize configuration
[CronPrime API](https://abichinger.github.io/vue-js-cron/typedoc/classes/_vue_js_cron_prime.CronPrime)

See [Vite Configuration Reference](https://vite.dev/config/).
[CronPrimeProps API](https://abichinger.github.io/vue-js-cron/typedoc/interfaces/_vue_js_cron_prime.CronPrimeProps)

## Project Setup

```sh
npm install
```
## Attribution

### Compile and Hot-Reload for Development

```sh
npm run dev
```

### Type-Check, Compile and Minify for Production

```sh
npm run build
```
This component is inspired by [react-js-cron](https://github.com/xrutayisire/react-js-cron) and [jqcron](https://github.com/arnapou/jqcron)
1 change: 1 addition & 0 deletions quasar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<a href="https://www.npmjs.com/package/@vue-js-cron/ant">Ant</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/element-plus">Element Plus</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/naive-ui">Naive UI</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/prime">PrimeVue</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/quasar">Quasar</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
</p>
Expand Down
1 change: 1 addition & 0 deletions vuetify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
<a href="https://www.npmjs.com/package/@vue-js-cron/ant">Ant</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/element-plus">Element Plus</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/naive-ui">Naive UI</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/prime">PrimeVue</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/quasar">Quasar</a> |
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a>
</p>
Expand Down

0 comments on commit ab66cdb

Please sign in to comment.