Skip to content
This repository has been archived by the owner on Jul 12, 2024. It is now read-only.

Commit

Permalink
📝 improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chanlito committed Dec 28, 2018
1 parent 289fd0a commit 0b0eab4
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,53 @@
# Vuetify TSX

Vuetify TSX is just a wrapper lib around vuetify components.
This lib use `vue-tsx-support` under the hood to support TSX (JSX for TypeScript).

## Setup

```bash
npm install vuetify-tsx
```

## Usage

```tsx
import { component } from 'vue-tsx-support';
import { VApp, VContent } from 'vuetify-tsx';

export default component({
name: 'Default',
render() {
return (
<VApp>
<VContent>
<nuxt />
</VContent>
</VApp>
);
},
});
```

## Tip

Use `babel-plugin-import` to reduce bundle size.

```js
{
plugins: [
[
'import',
{
libraryName: 'vuetify-tsx',
libraryDirectory: 'lib',
camel2DashComponentName: false,
},
],
],
}
```

## LICENSE

MIT

0 comments on commit 0b0eab4

Please sign in to comment.