Skip to content

Commit 73c3997

Browse files
authored
Merge pull request #2 from Namchee/rollup-build
docs: Update documentation
2 parents a431128 + c43723a commit 73c3997

File tree

3 files changed

+4
-5
lines changed

3 files changed

+4
-5
lines changed

README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Tetikus
22

3-
[![Code Style: Google](https://img.shields.io/badge/code%20style-google-blueviolet.svg)](https://github.com/google/gts) [![Vue 3](https://img.shields.io/badge/vue-3.x-brightgreen.svg)](https://github.com/vuejs/vue-next) [![NPM Package Version](https://img.shields.io/npm/v/@namchee/tetikus)](https://www.npmjs.com/package/@namchee/tetikus) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@namchee/tetikus)](https://bundlephobia.com/result?p=@namchee/tetikus@0.1.0)
3+
[![Code Style: Google](https://img.shields.io/badge/code%20style-google-blueviolet.svg)](https://github.com/google/gts) [![Vue 3](https://img.shields.io/badge/vue-3.x-brightgreen.svg)](https://github.com/vuejs/vue-next) [![NPM Package Version](https://img.shields.io/npm/v/@namchee/tetikus)](https://www.npmjs.com/package/@namchee/tetikus) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@namchee/tetikus)](https://bundlephobia.com/result?p=@namchee/tetikus@0.2.0)
44

55
Tetikus is a custom cursor component made for Vue 3.
66

@@ -29,13 +29,12 @@ After that, you can add it to your Vue 3 application by using the `.use()` like:
2929
import { createApp } from 'vue';
3030
import Root from './Root.vue';
3131
import Tetikus from '@namchee/tetikus';
32+
import '@namchee/tetikus/dist/tetikus.css';
3233

3334
const app = createApp(Root);
3435
app.use(Tetikus);
3536
```
3637

37-
> Note: If you are using an ES Modules based dev server, the bundler won't find the `install` method. Instead, use `app.use(Tetikus.default)` as temporary leverage.
38-
3938
## Usage
4039

4140
Just use the component in your root file.

package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@namchee/tetikus",
3-
"version": "0.1.2",
3+
"version": "0.2.0",
44
"description": "A custom cursor component for Vue 3 ✌️",
55
"author": "Cristopher Namchee <[email protected]>",
66
"scripts": {

0 commit comments

Comments
 (0)