alighasami/xyflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(readme): formatting

Browse Source
This commit is contained in:
moklick
2020-10-29 13:48:34 +01:00
parent 58aaceb5c9
commit 0d7a14e415
1 changed files with 7 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -9
View File
@@ -1,20 +1,18 @@
[![react-flow](https://user-images.githubusercontent.com/2857535/95224198-b2540000-07fa-11eb-832d-361d72d60345.jpg)](https://reactflow.dev) [![react-flow](https://user-images.githubusercontent.com/2857535/95224198-b2540000-07fa-11eb-832d-361d72d60345.jpg)](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. 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 - **Website:** https://reactflow.dev
- **Documentation:** https://reactflow.dev/docs - **Documentation:** https://reactflow.dev/docs
- **Examples:** https://reactflow.dev/examples - **Examples:** https://reactflow.dev/examples
# Installation ## Installation
``` ```
npm install react-flow-renderer 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). 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} />; 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`. 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. 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: 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 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). 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! 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)!