Skip to content

Commit d38e3fc

Browse files
committed
Update README
1 parent bb989ff commit d38e3fc

File tree

3 files changed

+119
-5
lines changed

3 files changed

+119
-5
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
# vue3-overmind
1+
# Vue 3 + Typescript + Overmind
22

33
Simple example of using Vue 3 + TypeScript + Overmind with hooks
44

55
* Vue 3 <https://v3.vuejs.org/>
66
* Overmind <https://www.overmindjs.org/>
7+
* TypeScript <https://www.typescriptlang.org/>
78

89
```
910
yarn install
@@ -27,7 +28,9 @@ yarn build
2728
yarn lint
2829
```
2930

30-
### Run Overmind debuggers
31+
### Using Overmind DevTools debugger
32+
33+
Overmind DevTools: <https://overmindjs.org/core/devtools>
3134

3235
```
3336
npx overmind-devtools@latest

src/components/HelloWorld.vue

Lines changed: 113 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,97 @@
11
<template>
2-
<div>
2+
<div class="hello">
33
<h2 class="text-lg">{{ state.welcome }}</h2>
4-
<SimpleCounter />
4+
<SimpleCounter class="mb-3" />
5+
<p>
6+
For a guide and recipes on how to configure / customize this project,<br />
7+
check out the
8+
<a href="https://cli.vuejs.org" target="_blank" rel="noopener"
9+
>vue-cli documentation</a
10+
>.
11+
</p>
12+
<h3>Installed CLI Plugins</h3>
13+
<ul>
14+
<li>
15+
<a
16+
href="https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-babel"
17+
target="_blank"
18+
rel="noopener"
19+
>babel</a
20+
>
21+
</li>
22+
<li>
23+
<a
24+
href="https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-typescript"
25+
target="_blank"
26+
rel="noopener"
27+
>typescript</a
28+
>
29+
</li>
30+
<li>
31+
<a
32+
href="https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-eslint"
33+
target="_blank"
34+
rel="noopener"
35+
>eslint</a
36+
>
37+
</li>
38+
</ul>
39+
<h3>Essential Links</h3>
40+
<ul>
41+
<li>
42+
<a href="https://vuejs.org" target="_blank" rel="noopener">Core Docs</a>
43+
</li>
44+
<li>
45+
<a href="https://forum.vuejs.org" target="_blank" rel="noopener"
46+
>Forum</a
47+
>
48+
</li>
49+
<li>
50+
<a href="https://chat.vuejs.org" target="_blank" rel="noopener"
51+
>Community Chat</a
52+
>
53+
</li>
54+
<li>
55+
<a href="https://twitter.com/vuejs" target="_blank" rel="noopener"
56+
>Twitter</a
57+
>
58+
</li>
59+
<li>
60+
<a href="https://news.vuejs.org" target="_blank" rel="noopener">News</a>
61+
</li>
62+
</ul>
63+
<h3>Ecosystem</h3>
64+
<ul>
65+
<li>
66+
<a href="https://router.vuejs.org" target="_blank" rel="noopener"
67+
>vue-router</a
68+
>
69+
</li>
70+
<li>
71+
<a href="https://vuex.vuejs.org" target="_blank" rel="noopener">vuex</a>
72+
</li>
73+
<li>
74+
<a
75+
href="https://github.com/vuejs/vue-devtools#vue-devtools"
76+
target="_blank"
77+
rel="noopener"
78+
>vue-devtools</a
79+
>
80+
</li>
81+
<li>
82+
<a href="https://vue-loader.vuejs.org" target="_blank" rel="noopener"
83+
>vue-loader</a
84+
>
85+
</li>
86+
<li>
87+
<a
88+
href="https://github.com/vuejs/awesome-vue"
89+
target="_blank"
90+
rel="noopener"
91+
>awesome-vue</a
92+
>
93+
</li>
94+
</ul>
595
</div>
696
</template>
797

@@ -15,9 +105,30 @@ export default defineComponent({
15105
components: {
16106
SimpleCounter,
17107
},
108+
props: {
109+
msg: String,
110+
},
18111
setup() {
19112
const state = useOvermind.state();
20113
return { state };
21114
},
22115
});
23116
</script>
117+
118+
<!-- Add "scoped" attribute to limit CSS to this component only -->
119+
<style scoped>
120+
h3 {
121+
margin: 40px 0 0;
122+
}
123+
ul {
124+
list-style-type: none;
125+
padding: 0;
126+
}
127+
li {
128+
display: inline-block;
129+
margin: 0 10px;
130+
}
131+
a {
132+
color: #42b983;
133+
}
134+
</style>

src/components/SimpleCounter.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<div class="pt-3">
33
<DecBtn @click="actions.inc" />
44
<span class="bg-gray-200 text-xl ml-3 mr-3">
5-
{{ state.counter }}
5+
Counter: {{ state.counter }}
66
</span>
77
<IncBtn @click="actions.dec" />
88
</div>

0 commit comments

Comments
 (0)