Skip to content

Commit b041816

Browse files
committed
docs: Update README.md
1 parent d07bdd7 commit b041816

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

README.md

Lines changed: 22 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@
3434

3535
</div>
3636

37-
To extend the app and make it more interactive, see code samples in the [Getting Started](https://v3.vuejs.org/guide/introduction.html#getting-started) docs.
38-
3937

4038
## Features
4139
> About this template project
@@ -62,6 +60,19 @@ Vue is similar to React, but many including myself believe that Vue is easier to
6260
See my [Resources](https://michaelcurrin.github.io/dev-resources/resources/javascript/packages/vue/) page to learn more about Vue.
6361

6462

63+
## Extending
64+
65+
### Functionality
66+
67+
To make the app more interactive, see code samples in the [Getting Started](https://v3.vuejs.org/guide/introduction.html#getting-started) docs.
68+
69+
### Components
70+
71+
To load components on the frontend as `.vue` files, see my [No build step](https://michaelcurrin.github.io/code-cookbook/recipes/javascript/packages/vue/no-build-step.html) guide. That also makes it easier to use scoped CSS.
72+
73+
Though, if you have a couple of components or your entire site is Vue pages (compared with adding Vue to HTML), then consider structuring your application as a Vue Node app that uses Vue CLI for developing tooling and optimized production builds (like for compiling and minifying).
74+
75+
6576
## Related projects
6677

6778
More of my templates:
@@ -71,7 +82,14 @@ More of my templates:
7182
- [![MichaelCurrin - react-quickstart](https://img.shields.io/static/v1?label=MichaelCurrin&message=react-quickstart&color=blue&logo=github)](https://github.com/MichaelCurrin/react-quickstart) - React with a CLI.
7283

7384

74-
## Developer notes
85+
## Development
86+
> Notes for developers
87+
88+
### Structure
89+
90+
This project deviates from the typical Vue CLI quickstart app. Part of the intention here is to show to add Vue to an existing site - so some content has been added directly to [index.html](/index.html) outside of the app. The CSS has been adjusted to be on `body` not `#app`.
91+
92+
A better setup for this project would be showing how to use some components like todo app or counter. And not necessarily in `app`. These could be on more targeted IDs. Need to research this approach as it is different from setting up a single app as entry-point.
7593

7694
### Formatting
7795

@@ -80,7 +98,7 @@ There is no `package.json` or use of Prettier.
8098
But you can run Prettier ad hoc like this to format the JS file, assuming you have Node installed.
8199

82100
```sh
83-
$ npx prettier -w main.js
101+
$ npx prettier -w '*.{js,css}'
84102
```
85103

86104
### Vue

0 commit comments

Comments
 (0)