Skip to content

Commit 80b2d6c

Browse files
Updating readme
1 parent 69abdee commit 80b2d6c

File tree

1 file changed

+30
-10
lines changed

1 file changed

+30
-10
lines changed

README.md

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,46 @@
1-
# Vuetify Drilldown Table (alpha)
1+
<p align="center">
2+
<img alt="Vuetify Logo" width="100" src="https://raw.githubusercontent.com/webdevnerdstuff/vuetify-drilldown-table/main/src/assets/vuetify-logo.svg">
3+
</p>
24

5+
<p>
6+
<h1 align="center">Vuetify Drilldown Table (alpha)</h1>
7+
</p>
38

4-
## Development Playground
5-
`pnpm i && pnpm play`
6-
7-
Playground file can be found in `./src/playground/PlaygroundPage.vue`
9+
<p align="center">
10+
<a href="https://www.npmjs.com/package/vuetify-drilldown-table">
11+
<img src="https://img.shields.io/npm/v/vuetify-drilldown-table?color=1867c0&logo=npm" alt="NPM Package">
12+
</a>
13+
&nbsp;
14+
<a href="https://github.com/webdevnerdstuff/vuetify-drilldown-table">
15+
<img src="https://img.shields.io/badge/GitHub-WebDevNerdStuff-brightgreen.svg?logo=github" alt="@WebDevNerdStuff">
16+
</a>
17+
</p>
818

919

1020
## Description
1121

12-
TBD
22+
The `vuetify-drilldown-table` component extends the functionality of the Vuetify 3 [v-data-table](https://vuetifyjs.com/en/components/data-tables/basics/) to recursively drilldown into child tables.
23+
24+
25+
## Development Playground
26+
27+
The `vuetify-drilldown-table` is still a work in progress as `v-data-table` is still in Vuetify Laps. If you would like to test the component 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.
1332

1433

1534
## Installation
35+
1636
Using [pnpm](https://pnpm.io/):
1737
```
18-
pnpm add [tbd]
38+
pnpm add vuetify-drilldown-table
1939
```
2040

2141
Using npm:
2242
```
23-
npm i [tbd]
43+
npm i vuetify-drilldown-table
2444
```
2545

2646
## Documentation
@@ -44,6 +64,6 @@ Copyright (c) 2023 WebDevNerdStuff
4464
Licensed under the [MIT license](https://github.com/webdevnerdstuff/vuetify-drilldown-table/blob/master/LICENSE.md).
4565

4666

47-
<!-- ## Legal
67+
## Legal
4868

49-
Vuetify and the Vuetify logo are trademarks of Vuetify. This component was not created or endorsed by Vuetify. -->
69+
Vuetify and the Vuetify logo are trademarks of Vuetify. This component was not created or endorsed by Vuetify.

0 commit comments

Comments
 (0)