@vue-layout/link/README.md

A package containing a link component.

# @vue-layout/link 🔗

[![npm version](https://badge.fury.io/js/@vue-layout%2Fgravatar.svg)](https://badge.fury.io/js/@vue-layout%2Fgravatar)
[![CI](https://github.com/Tada5hi/vue-layout/actions/workflows/main.yml/badge.svg)](https://github.com/Tada5hi/vue-layout/actions/workflows/main.yml)

A package containing a link component.

**Table of Contents**

- [Installation](#installation)
- [Usage](#usage)
- [License](#license)

## Installation

```
$ npm i --save @vue-layout/link
```

## Usage

Register the plugin.

```typescript
import install from '@vue-layout/link';
import { createApp } from 'vue'

const app = createApp({})

app.use(install, {
  /* optional options */
})
```

After the component is registered, it can be used as follows.

```vue
<template>
    <VCLink
        :to="'/route'"
    />
</template>
```

## License

Made with 💚

Published under [MIT License](./LICENSE).