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

chore: update README.md

Browse Source
This commit is contained in:
Braks
2022-04-24 13:34:22 +02:00
parent b6848e37c8
commit aaccbb4b3e
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+16 -8
View File
@@ -2,8 +2,6 @@
[![vue flow](package/src/assets/vue-flow.gif)](https://vueflow.dev/) [![vue flow](package/src/assets/vue-flow.gif)](https://vueflow.dev/)
![top-language](https://img.shields.io/github/languages/top/bcakmakoglu/vue-flow) ![top-language](https://img.shields.io/github/languages/top/bcakmakoglu/vue-flow)
[![dependencies Status](https://status.david-dm.org/gh/bcakmakoglu/vue-flow.svg)](https://david-dm.org/bcakmakoglu/vue-flow)
[![devDependencies Status](https://status.david-dm.org/gh/bcakmakoglu/vue-flow.svg?type=dev)](https://david-dm.org/bcakmakoglu/vue-flow?type=dev)
![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/bcakmakoglu/vue-flow) ![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/bcakmakoglu/vue-flow)
![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)
@@ -13,7 +11,7 @@
With Vue Flow you can build your own, customized node-based applications like static diagrams or even more complex and With Vue Flow you can build your own, customized node-based applications like static diagrams or even more complex and
interactive editors! interactive editors!
You can find a detailed explanation on how to get started in the [documentation](https://vueflow.dev/docs) or check You can find a detailed explanation on how to get started in the [documentation](https://vueflow.dev/guide) or check
the [examples](https://vueflow.dev/examples). the [examples](https://vueflow.dev/examples).
## ⭐️ Features ## ⭐️ Features
@@ -60,7 +58,7 @@ A simple setup could look like this:
```vue ```vue
<!-- Flowchart.vue --> <!-- Flowchart.vue -->
<template> <template>
<VueFlow :elements="elements"></VueFlow> <VueFlow v-model="elements"></VueFlow>
</template> </template>
<script setup> <script setup>
import { VueFlow } from '@braks/vue-flow' import { VueFlow } from '@braks/vue-flow'
@@ -117,8 +115,18 @@ Thanks for your star!
[![Stargazers repo roster for @braks/vue-flow](https://reporoster.com/stars/bcakmakoglu/vue-flow)](https://github.com/bcakmakoglu/vue-flow/stargazers) [![Stargazers repo roster for @braks/vue-flow](https://reporoster.com/stars/bcakmakoglu/vue-flow)](https://github.com/bcakmakoglu/vue-flow/stargazers)
## 💝 Acknowledgement ## 💝 Special Thanks
This project is based on [webkid's](https://webkid.io/) [react flow](https://reactflow.dev/). I wholeheartedly thank This project is built with
them for their amazing work! Without them this project would've been impossible for me.
Please consider [donating](https://github.com/sponsors/wbkd) to them if you like Vue Flow. - [React Flow](https://reactflow.dev/)
- Vue flow is heavily based on [webkid's](https://webkid.io/) [react flow](https://reactflow.dev/). I wholeheartedly thank
them for their amazing work! Without them this vue flow would not exist.
Please consider [donating](https://github.com/sponsors/wbkd) to them!
- [D3.js](https://d3js.org/)
- D3 makes all the zoom and pan actions in the graph possible.
Check it out to see if you can find other uses for it too!
- [VueUse](https://vueuse.org/)
- VueUse is a collection of helpful utilities/composables that have been battle tested.