diff --git a/packages/additional-components/README.md b/packages/additional-components/README.md index b32894d8..25dd6448 100644 --- a/packages/additional-components/README.md +++ b/packages/additional-components/README.md @@ -1,3 +1,48 @@ -# Vue Flow Additional Components +# Vue Flow: Additional Components -This package contains additional components like `Background`, `Controls` & `MiniMap`. +This package contains additional components that can be used with Vue Flow. +These components include: + +- [Background](https://vueflow.dev/guide/components/background) +- [Controls](https://vueflow.dev/guide/components/controls) + - [ControlButton](https://vueflow.dev/guide/components/control-button) +- [MiniMap](https://vueflow.dev/guide/components/minimap) + - [MiniMap Node](https://vueflow.dev/guide/components/minimap-node) + +## 🛠 Setup + +```bash +# install +$ yarn add @vue-flow/additional-components + +# or +$ npm i --save @vue-flow/additional-components +``` + +## 🎮 Quickstart + +```vue + + + +``` diff --git a/packages/pathfinding-edge/README.md b/packages/pathfinding-edge/README.md index 80f4891b..47a11701 100644 --- a/packages/pathfinding-edge/README.md +++ b/packages/pathfinding-edge/README.md @@ -6,10 +6,10 @@ __Custom edge that avoids crossing nodes__ ```bash # install -$ yarn add @vue-flow/core-pathfinding-edge +$ yarn add @vue-flow/pathfinding-edge # or -$ npm i --save @vue-flow/core-pathfinding-edge +$ npm i --save @vue-flow/pathfinding-edge ``` ## 🎮 Quickstart @@ -17,7 +17,7 @@ $ npm i --save @vue-flow/core-pathfinding-edge ```vue