Skip to content

Commit f2f7bc8

Browse files
committed
docs: update README
1 parent 5e86236 commit f2f7bc8

File tree

3 files changed

+27
-46
lines changed

3 files changed

+27
-46
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,10 @@ yarn build-docs
7575

7676
## Attribution
7777

78-
This component is inspired by [react-js-cron](https://github.com/xrutayisire/react-js-cron) and [jqcron](https://github.com/arnapou/jqcron)
78+
This component is inspired by [react-js-cron](https://github.com/xrutayisire/react-js-cron) and [jqcron](https://github.com/arnapou/jqcron)
79+
80+
### Articles
81+
82+
[Renderless Components in Vue.js](https://adamwathan.me/renderless-components-in-vuejs/) by Adam Wathan
83+
<br />
84+
[Composition API v Renderless Components](https://dev.to/thomasferro/composition-api-v-renderless-components-let-s-use-vue-3-s-features-to-clean-our-components-n25) by Thomas Ferro

core/README.md

Lines changed: 18 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,26 @@
1-
# core-ts
1+
![Vue.js Cron Vuetify Hero](https://raw.githubusercontent.com/abichinger/vue-js-cron/main/assets/vue-js-cron-hero.png)
22

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

5-
## Recommended IDE Setup
7+
<p align="center">
8+
<a href="https://www.npmjs.com/package/@vue-js-cron/core">Core</a> |
9+
<a href="https://www.npmjs.com/package/@vue-js-cron/light">Light</a> |
10+
<a href="https://www.npmjs.com/package/@vue-js-cron/vuetify">Vuetify</a> |
11+
<a href="https://www.npmjs.com/package/@vue-js-cron/element-plus">Element Plus</a> |
12+
<a href="https://www.npmjs.com/package/@vue-js-cron/ant">Ant</a> |
13+
<a href="https://www.npmjs.com/package/@vue-js-cron/quasar">Quasar</a>
14+
</p>
615

7-
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
16+
## Usage - Core
817

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

11-
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 [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
20+
[Get Started](https://abichinger.github.io/vue-js-cron/guide/getting-started.html#renderless)
1221

13-
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
22+
[API - cron-core](https://abichinger.github.io/vue-js-cron/api/core.html)
1423

15-
1. Disable the built-in TypeScript Extension
16-
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
17-
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
18-
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
24+
## Attribution
1925

20-
## Customize configuration
21-
22-
See [Vite Configuration Reference](https://vitejs.dev/config/).
23-
24-
## Project Setup
25-
26-
```sh
27-
npm install
28-
```
29-
30-
### Compile and Hot-Reload for Development
31-
32-
```sh
33-
npm run dev
34-
```
35-
36-
### Type-Check, Compile and Minify for Production
37-
38-
```sh
39-
npm run build
40-
```
41-
42-
### Run Unit Tests with [Vitest](https://vitest.dev/)
43-
44-
```sh
45-
npm run test:unit
46-
```
47-
48-
### Lint with [ESLint](https://eslint.org/)
49-
50-
```sh
51-
npm run lint
52-
```
26+
This component is inspired by [react-js-cron](https://github.com/xrutayisire/react-js-cron) and [jqcron](https://github.com/arnapou/jqcron)

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@
3333
"test-core": "cd core && yarn test",
3434
"dry-run": "multi-semantic-release --dry-run --ignore-private-packages",
3535
"lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts",
36-
"lint-fix": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix"
36+
"lint-fix": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix",
37+
"build-readme": "node scripts/gen_readme.js"
3738
},
3839
"devDependencies": {
3940
"@babel/core": "^7.12.13",

0 commit comments

Comments
 (0)