Skip to content

Commit 9ebcaa2

Browse files
committed
chore: update readme file
1 parent 70768bc commit 9ebcaa2

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,41 @@ A Vue3 starter project setup with
1212
- Prettier
1313
- and some custom preferences.
1414

15+
### Run this project:
16+
1517
```
1618
yarn
1719
yarn dev
1820
```
21+
22+
### Change site name
23+
24+
In `App.vue` change the following,
25+
26+
```Javascript
27+
const siteName = 'Vite App' // add your site name here
28+
```
29+
30+
### Layouts
31+
32+
You can add layouts in your project if you want. You will find a `default.vue` layout example in this project.
33+
34+
### Pages
35+
36+
You can add pages to your project. You will find two example pages in the `pages` directory (`Home.vue` and `About.vue`). **Do not forget to register the pages in the `router`**. You will also find a `router/index.js` file to register your pages.
37+
38+
### Meta info
39+
40+
You can add meta information in your pages. Here is an example,
41+
42+
```Javascript
43+
<script setup>
44+
import { useMeta } from 'vue-meta'
45+
46+
useMeta({
47+
title: 'Homepage',
48+
})
49+
...
50+
51+
</script>
52+
```

0 commit comments

Comments
 (0)