Skip to content

Commit dd22af8

Browse files
Added basic copy
1 parent 68e9afe commit dd22af8

File tree

3 files changed

+91
-11
lines changed

3 files changed

+91
-11
lines changed

Diff for: CHANGELOG.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Change Log
2+
All notable changes to the "vuetify-inline-fields" plugin will be documented in this file.
3+
4+
## v1.0.0
5+
TBD
6+
[main] (@webdevnerdstuff)

Diff for: LICENSE.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 WebDevNerdStuff
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

Diff for: README.md

+64-11
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,71 @@
1-
# Vue 3 + TypeScript + Vite
1+
<!-- <p align="center">
2+
<img alt="Vuetify Logo" width="100" src="https://raw.githubusercontent.com/webdevnerdstuff/vuetify-inline-fields/main/src/assets/vuetify-logo.svg">
3+
</p> -->
24

3-
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
5+
<p>
6+
<h1 align="center">Vuetify Inline Fields (alpha)</h1>
7+
</p>
48

5-
## Recommended IDE Setup
9+
<p align="center">
10+
<!-- <a href="https://www.npmjs.com/package/vuetify-inline-fields">
11+
<img src="https://img.shields.io/npm/v/vuetify-inline-fields?color=1867c0&logo=npm" alt="NPM Package">
12+
</a>
13+
&nbsp; -->
14+
<a href="https://github.com/webdevnerdstuff/vuetify-inline-fields">
15+
<img src="https://img.shields.io/badge/GitHub-WebDevNerdStuff-brightgreen.svg?logo=github" alt="@WebDevNerdStuff">
16+
</a>
17+
</p>
618

7-
- [VS Code](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).
819

9-
## Type Support For `.vue` Imports in TS
20+
## Description
1021

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.
22+
TBD
1223

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:
1424

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.
25+
## Development Playground
26+
27+
The `vuetify-inline-fields` is still a work in progress. If you would like to test the component library out, you can clone the repo and run the following commands:
28+
29+
`pnpm i && pnpm play`
30+
31+
This will open up a Playground page that loads the file `./src/playground/PlaygroundPage.vue`. You can edit this file to test out the component.
32+
33+
34+
## Installation
35+
36+
Using [pnpm](https://pnpm.io/):
37+
```
38+
pnpm add TBD
39+
```
40+
41+
Using npm:
42+
```
43+
npm i TBD
44+
```
45+
46+
## Documentation
47+
48+
Component is still in development. Documentation will be added once component is ready for production.
49+
<!-- [Documentation & Demo](https://webdevnerdstuff.github.io/vuetify-inline-fields/) -->
50+
51+
## Dependencies
52+
53+
[Vuetify v3](https://vuetifyjs.com/)
54+
[Vue 3](https://vuejs.org/)
55+
[VueUse](https://vueuse.org/)
56+
57+
58+
## Change Log
59+
60+
[CHANGELOG](https://github.com/webdevnerdstuff/vuetify-inline-fields/blob/master/CHANGELOG.md)
61+
62+
63+
## License
64+
65+
Copyright (c) 2023 WebDevNerdStuff
66+
Licensed under the [MIT license](https://github.com/webdevnerdstuff/vuetify-inline-fields/blob/master/LICENSE.md).
67+
68+
69+
## Legal
70+
71+
Vuetify and the Vuetify logo are trademarks of Vuetify. This component was not created or endorsed by Vuetify.

0 commit comments

Comments
 (0)