diff --git a/packages/svelte/README.md b/packages/svelte/README.md index 60152e7a..cedf99aa 100644 --- a/packages/svelte/README.md +++ b/packages/svelte/README.md @@ -6,18 +6,21 @@ A highly customizable Svelte component for building interactive graphs and node- If you want to check out the current version you need to run the following command from the root directory: -1. `pnpm install` - installs dependencies +1. `pnpm install` - install dependencies 2. `pnpm build` - needs to be done once 3. `pnpm dev` - starts dev server You can now access the examples under http://127.0.0.1:5173 -## A basic flow +## Getting started + +We are working on a new website and everything so there are no docs for Svelte Flow yet. Everything is typed, so your IDE should help you a bit and you can also the [React Flow docs](https://reactflow.dev/docs) because the API is very similar. You can also check out the [Svelte Flow examples](/packages/svelte/src/routes) in this repo. A basic flow looks like this: ```svelte - console.log('on node click', event)} > - console.log('on node click', event)} - > - - - - - + + + + ```