update(docs): README.md
Signed-off-by: Braks <78412429+bcakmakoglu@users.noreply.github.com>
This commit is contained in:
@@ -12,8 +12,7 @@ __A customizable Vue3 Flowchart.__
|
|||||||
|
|
||||||
### __🚧 This library is still under construction__
|
### __🚧 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
|
Check the [docs](https://vue-flow.vercel.app/docs) and [examples](https://vue-flow.vercel.app/examples) to get started.
|
||||||
idea how to start using Vue Flow.
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
@@ -21,7 +20,6 @@ idea how to start using Vue Flow.
|
|||||||
|
|
||||||
- 🦾 Fully written in TypeScript
|
- 🦾 Fully written in TypeScript
|
||||||
|
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
* [🛠 Setup](#-setup)
|
* [🛠 Setup](#-setup)
|
||||||
@@ -30,7 +28,6 @@ idea how to start using Vue Flow.
|
|||||||
|
|
||||||
* [🧪 Development](#-development)
|
* [🧪 Development](#-development)
|
||||||
|
|
||||||
|
|
||||||
## 🛠 Setup
|
## 🛠 Setup
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -42,13 +39,14 @@ $ yarn add @braks/vue-flow
|
|||||||
## 🎮 Quickstart
|
## 🎮 Quickstart
|
||||||
|
|
||||||
```vue
|
```vue
|
||||||
|
|
||||||
<template>
|
<template>
|
||||||
<Flow :elements="elements"></Flow>
|
<Flow :elements="elements"></Flow>
|
||||||
</template>
|
</template>
|
||||||
<script setup>
|
<script setup>
|
||||||
import { Flow, Elements } from '@braks/vue-flow'
|
import { Flow, Elements } from '@braks/vue-flow'
|
||||||
|
|
||||||
const elements = ref<Elements>([
|
const elements = ref < Elements > ([
|
||||||
{
|
{
|
||||||
id: '1',
|
id: '1',
|
||||||
data: {
|
data: {
|
||||||
|
|||||||
Reference in New Issue
Block a user