alighasami/vue-flow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update(docs): README.md

Browse Source 
Signed-off-by: Braks <78412429+bcakmakoglu@users.noreply.github.com>
This commit is contained in:
Braks
2021-11-16 15:44:24 +01:00
parent a0921859ce
commit 63f710e422
1 changed files with 10 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+10 -13
View File
@@ -8,11 +8,17 @@
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/bcakmakoglu/vue-flow) ![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/bcakmakoglu/vue-flow)
![GitHub last commit](https://img.shields.io/github/last-commit/bcakmakoglu/vue-flow) ![GitHub last commit](https://img.shields.io/github/last-commit/bcakmakoglu/vue-flow)
__A customizable Vue3 Flowchart.__ ### __Vue Flow: A highly customizable Vue3 Flowchart component.__
Check the [docs](https://vue-flow.vercel.app/docs) and [examples](https://vue-flow.vercel.app/examples) to get started. With Vue Flow you can build your own, customized node-based applications like static diagrams or even more complex and
interactive editors!
## Features You can find a detailed explanation on how to get started in the [documentation](https://vue-flow.vercel.app/docs) or check
the [examples](https://vue-flow.vercel.app/examples).
If you want to see how it's used with Nuxt3, check out the [docs repo](https://github.com/bcakmakoglu/vue-flow-docs)!
## ⭐️ Features
- 👶 Easy to use: Seamless zooming & panning behaviour and single and multi-selections of - 👶 Easy to use: Seamless zooming & panning behaviour and single and multi-selections of
elements elements
@@ -33,14 +39,6 @@ Check the [docs](https://vue-flow.vercel.app/docs) and [examples](https://vue-fl
- 🦾 Fully written in TypeScript - 🦾 Fully written in TypeScript
## Table of Contents
* [🛠 Setup](#-setup)
* [🎮 Quickstart](#-quickstart)
* [🧪 Development](#-development)
## 🛠 Setup ## 🛠 Setup
```bash ```bash
@@ -52,7 +50,6 @@ $ yarn add @braks/vue-flow
## 🎮 Quickstart ## 🎮 Quickstart
```vue ```vue
<template> <template>
<Flow :elements="elements"></Flow> <Flow :elements="elements"></Flow>
</template> </template>
@@ -85,6 +82,6 @@ $ yarn dev
$ yarn build $ yarn build
``` ```
## Credit ## 💝 Credit
Thanks to [webkid](https://webkid.io/) for creating React Flow! Without their work this would've been impossible for me. Thanks to [webkid](https://webkid.io/) for creating React Flow! Without their work this would've been impossible for me.