Skip to content

Commit 0a55693

Browse files
committed
update(docs): README.md
Signed-off-by: Braks <[email protected]>
1 parent ffdadda commit 0a55693

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,14 @@ __A customizable Vue3 Flowchart.__
1212

1313
### __🚧 This library is still under construction__
1414

15-
_Docs aren't available yet_ but if you still want to try it out, check the available [examples](./examples) to get an
16-
idea how to start using Vue Flow.
15+
Check the [docs](https://vue-flow.vercel.app/docs) and [examples](https://vue-flow.vercel.app/examples) to get started.
1716

1817
## Features
1918

2019
- 🎨 Customizable
2120

2221
- 🦾 Fully written in TypeScript
2322

24-
2523
## Table of Contents
2624

2725
* [🛠 Setup](#-setup)
@@ -30,7 +28,6 @@ idea how to start using Vue Flow.
3028

3129
* [🧪 Development](#-development)
3230

33-
3431
## 🛠 Setup
3532

3633
```bash
@@ -42,13 +39,14 @@ $ yarn add @braks/vue-flow
4239
## 🎮 Quickstart
4340

4441
```vue
42+
4543
<template>
4644
<Flow :elements="elements"></Flow>
4745
</template>
4846
<script setup>
4947
import { Flow, Elements } from '@braks/vue-flow'
5048
51-
const elements = ref<Elements>([
49+
const elements = ref < Elements > ([
5250
{
5351
id: '1',
5452
data: {

0 commit comments

Comments
 (0)