Skip to content

Commit

Permalink
update readmeS
Browse files Browse the repository at this point in the history
  • Loading branch information
brillout committed Feb 12, 2025
1 parent c361b62 commit be476af
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 31 deletions.
1 change: 1 addition & 0 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
For more examples, see [Bati](https://batijs.dev) which generates `vike-vue` apps.
11 changes: 11 additions & 0 deletions examples/full/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Full-fledged example of using `vike-vue`.

> [!NOTE]
> For more examples, see [Bati](https://batijs.dev) which generates `vike-vue` apps.
```bash
git clone git@github.com:vikejs/vike-vue
cd vike-vue/examples/full/
npm install
npm run dev
```
18 changes: 0 additions & 18 deletions examples/full/readme.md

This file was deleted.

3 changes: 3 additions & 0 deletions examples/minimal/readme.md → examples/minimal/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Minimal example of using `vike-vue`.

> [!NOTE]
> For more examples, see [Bati](https://batijs.dev) which generates `vike-vue` apps.
```bash
git clone git@github.com:vikejs/vike-vue
cd vike-vue/examples/minimal/
Expand Down
11 changes: 11 additions & 0 deletions examples/vue-pinia/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Example of using [Pinia](https://pinia.vuejs.org) with the `vike-vue-pinia` extension.

> [!NOTE]
> For more examples, see [Bati](https://batijs.dev) which generates `vike-vue` apps.
```bash
git clone git@github.com:vikejs/vike-vue
cd vike-vue/examples/vue-pinia/
npm install
npm run dev
```
9 changes: 0 additions & 9 deletions examples/vue-pinia/readme.md

This file was deleted.

10 changes: 6 additions & 4 deletions examples/vue-query/readme.md → examples/vue-query/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
Example of using [TanStack Query](https://tanstack.com/query/latest) with the `vike-vue-query` extension.

> [!NOTE]
> For more examples, see [Bati](https://batijs.dev) which generates `vike-vue` apps.
```bash
git clone git@github.com:vikejs/vike-vue
cd vike-vue/
pnpm install
cd examples/vue-query/
pnpm run dev
cd vike-vue/examples/vue-query/
npm install
npm run dev
```

0 comments on commit be476af

Please sign in to comment.