Skip to content

Commit

Permalink
Merge pull request #2 from Namchee/rollup-build
Browse files Browse the repository at this point in the history
docs: Update documentation
  • Loading branch information
Namchee authored Sep 8, 2020
2 parents a431128 + c43723a commit 73c3997
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 5 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Tetikus

[![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)
[![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)

Tetikus is a custom cursor component made for Vue 3.

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

const app = createApp(Root);
app.use(Tetikus);
```

> 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.
## Usage

Just use the component in your root file.
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@namchee/tetikus",
"version": "0.1.2",
"version": "0.2.0",
"description": "A custom cursor component for Vue 3 ✌️",
"author": "Cristopher Namchee <[email protected]>",
"scripts": {
Expand Down

0 comments on commit 73c3997

Please sign in to comment.