chore(readme): update

This commit is contained in:
moklick
2023-06-14 17:07:32 +02:00
parent 1638f641aa
commit 80c694aceb
2 changed files with 29 additions and 1 deletions

View File

@@ -15,13 +15,15 @@ What is “xyflow”? Learn more [here](https://wbkd.notion.site/Upcoming-Change
## 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.
If you want to start right away you can check out the [Svelte Flow examples Stackblitz project](https://stackblitz.com/edit/svelte-flow-examples?file=src%2Froutes%2Foverview%2F%2Bpage.svelte).
A basic flow looks like this:
```svelte
<script lang="ts">
import { writable } from 'svelte/store';
import { SvelteFlow,
import {
SvelteFlow,
SvelteFlowProvider,
Controls,
Background,
@@ -75,6 +77,7 @@ A basic flow looks like this:
<MiniMap />
</SvelteFlow>
```
## How to Contribute
**Show us what you make:** Drop it in into our [Discord Server](https://discord.com/invite/Bqt6xrs), [tweet](https://twitter.com/reactflowdev) at us, or email us at info@reactflow.dev

View File

@@ -8,3 +8,28 @@ Core system that powers React Flow and Svelte Flow.
npm install @xyflow/system
```
## What is this package about?
The @xyflow/system package was created to have a place for vanilla utils for React Flow and Svelte Flow. The package exports helpers for edge creation, pan and zoom, dragging of nodes, general utils and lots of types. All the helpers are specifically built for React Flow and Svelte Flow so it's probably not too interesting to use them with other libraries.
### XYPanZoom
### XYDrag
### XYHandle
### XYMinimap
### Edge utils
### Store utils
### Dom utils
### Marker utils
### Graph utils
### General utils