diff --git a/README.md b/README.md index c1346d6b..09074852 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ -# React Flow in Vue3 = Revue Flow -[![contentful](./assets/Revueflow.png)](https://reactflow.dev/) -![top-language](https://img.shields.io/github/languages/top/bcakmakoglu/revue-flow) -[![dependencies Status](https://status.david-dm.org/gh/bcakmakoglu/revue-flow.svg)](https://david-dm.org/bcakmakoglu/revue-flow) -[![devDependencies Status](https://status.david-dm.org/gh/bcakmakoglu/revue-flow.svg?type=dev)](https://david-dm.org/bcakmakoglu/revue-flow?type=dev) -![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/bcakmakoglu/revue-flow) -![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/bcakmakoglu/revue-flow) -![GitHub last commit](https://img.shields.io/github/last-commit/bcakmakoglu/revue-flow) +# Vue Flow +[![vue flow](./assets/vue-flow.gif)](https://reactflow.dev/) +![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) +![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) This repo is still a big construction site with nothing really finished. You can check the examples to see what's working and what's not. Please visit [React Flow](https://reactflow.dev/) and support them if you like the idea. They did most of the heavy lifting by writing the library in the first place. -All I did is bring it to Vue3. +All I did is bring it to Vue. ### Motivation Seeing as many libraries exist in the React ecosystem and Vue sadly does not get the same @@ -20,31 +20,29 @@ love and attention, I decided to port the React Flow library to Vue.js. ## Usage Check the React Flow docs for usage. It's really the same. -### Vue3 +### Vue 3 ```bash -# install revue flow -$ yarn add @braks/revue-flow +# install vue flow +$ pnpm add @braks/vue-flow # or -$ npm i --save @braks/revue-flow +$ npm i --save @braks/vue-flow ``` -### Vue2 -This doesn't work with Vue2, sorry. - -## Development -This project uses Vite for development and Rollup to create a distribution. +### Vue 2 +Vue Flow doesn't work with Vue 2, sorry. +## 🧪 Development ```bash # start (dev) -$ yarn dev +$ pnpm dev # build app -$ yarn build +$ pnpm build # serve app from build -$ yarn serve +$ pnpm serve # build dist -$ yarn build:dist +$ pnpm build:dist ``` diff --git a/assets/Revueflow.png b/assets/Revueflow.png deleted file mode 100644 index c76e0527..00000000 Binary files a/assets/Revueflow.png and /dev/null differ diff --git a/assets/vue-flow.gif b/assets/vue-flow.gif new file mode 100644 index 00000000..7a624780 Binary files /dev/null and b/assets/vue-flow.gif differ diff --git a/examples/Basic/Basic.vue b/examples/Basic/Basic.vue index 557a0399..de50e3b8 100644 --- a/examples/Basic/Basic.vue +++ b/examples/Basic/Basic.vue @@ -54,7 +54,7 @@ const toggleClassnames = () => {