docs(readme): formatting
This commit is contained in:
@@ -1,20 +1,18 @@
|
||||
[](https://reactflow.dev)
|
||||
|
||||
# React Flow
|
||||
|
||||
React Flow is a library for building node-based graphs. You can easily implement custom node types and it comes with components like a mini-map and graph controls. Feel free to check out the [examples](https://reactflow.dev/) or read the [blog post](https://webkid.io/blog/react-flow-node-based-graph-library/) to get started.
|
||||
|
||||
- **Website:** https://reactflow.dev
|
||||
- **Documentation:** https://reactflow.dev/docs
|
||||
- **Examples:** https://reactflow.dev/examples
|
||||
|
||||
# Installation
|
||||
## Installation
|
||||
|
||||
```
|
||||
npm install react-flow-renderer
|
||||
```
|
||||
|
||||
# Quick Start
|
||||
## Quick Start
|
||||
|
||||
This is a very basic example of how to use React Flow. You can find more advanced examples on the [website](https://reactflow.dev/examples).
|
||||
|
||||
@@ -32,7 +30,7 @@ const elements = [
|
||||
const BasicFlow = () => <ReactFlow elements={elements} />;
|
||||
```
|
||||
|
||||
# Development
|
||||
## Development
|
||||
|
||||
You need to install the React Flow dependencies via `npm install` and the ones of the examples `cd example && npm install`.
|
||||
|
||||
@@ -44,7 +42,7 @@ npm run dev
|
||||
|
||||
This serves the content of the `example` folder and watches changes inside the `src` folder. The examples are using the source of the `src` folder.
|
||||
|
||||
# Testing
|
||||
## Testing
|
||||
|
||||
Testing is done with cypress. You can find the tests in the [`integration/flow`](/cypress/integration/flow) folder. In order to run the tests do:
|
||||
|
||||
@@ -52,14 +50,14 @@ Testing is done with cypress. You can find the tests in the [`integration/flow`]
|
||||
npm run test
|
||||
```
|
||||
|
||||
# Support
|
||||
## Support
|
||||
|
||||
If you need custom support or features for your application we are [happy to hear from you](https://webkid.io/contact).
|
||||
|
||||
## Thanks!
|
||||
### Thanks!
|
||||
|
||||
Special thanks to [Andy Lindemann](https://github.com/AndyLnd) for a lot of helpful contributions!
|
||||
|
||||
---
|
||||
|
||||
React Flow was initially developed by [webkid](https://webkid.io), a data visualization company from Berlin. If you need help or want to develop react-based tools or data visualizations, get in touch!
|
||||
React Flow was initially developed by [webkid](https://webkid.io), a data visualization company from Berlin. If you need help or want to develop react-based tools or data visualizations, [get in touch](https://webkid.io/contact)!
|
||||
|
||||
Reference in New Issue
Block a user