update(docs): README.md

Signed-off-by: Braks <78412429+bcakmakoglu@users.noreply.github.com>
This commit is contained in:
Braks
2021-11-15 20:35:26 +01:00
parent ffdadda051
commit 0a55693fb1

View File

@@ -12,8 +12,7 @@ __A customizable Vue3 Flowchart.__
### __🚧 This library is still under construction__
_Docs aren't available yet_ but if you still want to try it out, check the available [examples](./examples) to get an
idea how to start using Vue Flow.
Check the [docs](https://vue-flow.vercel.app/docs) and [examples](https://vue-flow.vercel.app/examples) to get started.
## Features
@@ -21,7 +20,6 @@ idea how to start using Vue Flow.
- 🦾 Fully written in TypeScript
## Table of Contents
* [🛠 Setup](#-setup)
@@ -30,7 +28,6 @@ idea how to start using Vue Flow.
* [🧪 Development](#-development)
## 🛠 Setup
```bash
@@ -42,13 +39,14 @@ $ yarn add @braks/vue-flow
## 🎮 Quickstart
```vue
<template>
<Flow :elements="elements"></Flow>
</template>
<script setup>
import { Flow, Elements } from '@braks/vue-flow'
const elements = ref<Elements>([
const elements = ref < Elements > ([
{
id: '1',
data: {