Update README.md

2022-01-21 11:23:34 +01:00
parent 0cfcf656a0
commit 2a4dfce61c
1 changed files with 9 additions and 27 deletions
--- a/README.md
+++ b/README.md
@@ -1,19 +1,18 @@
 [![react-flow](https://user-images.githubusercontent.com/2857535/95224198-b2540000-07fa-11eb-832d-361d72d60345.jpg)](https://reactflow.dev)

-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.
+<div align="center">

-## 👉 Next Major Release 👈
+  ![GitHub License MIT](https://img.shields.io/github/license/wbkd/react-flow?color=%23FF0072)
+  ![npm downloads](https://img.shields.io/npm/dt/react-flow-renderer?color=%23FF0072&label=downloads)
+  ![GitHub Repo stars](https://img.shields.io/github/stars/wbkd/react-flow?color=%23FF0072)
+  ![GitHub release (latest by date)](https://img.shields.io/github/v/release/wbkd/react-flow?color=%23FF0072)

-We are currently working on the next version. You can find the installation instructions and breaking changes in [this PR](https://github.com/wbkd/react-flow/pull/1555). Your feedback is highly appreciated :) 
+**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.**

- **Website:** https://reactflow.dev
- **Documentation:** https://reactflow.dev/docs
- **Examples:** https://reactflow.dev/examples
- **Website/Docs Repository:** https://github.com/wbkd/react-flow-docs
- **Community:** https://discord.gg/Bqt6xrs
- **Sponsorship:** https://github.com/sponsors/wbkd
+[Getting Started](https://reactflow.dev) | [Website](https://reactflow.dev) | [Documentation](https://reactflow.dev/docs) | [Examples](https://reactflow.dev/examples)
+</div>

-React Flow was initially created for [datablocks](https://datablocks.pro). A node-based editor for transforming, analyzing and visualizing data.
+----

 ## Installation

@@ -69,20 +68,3 @@ Testing is done with cypress. You can find the tests in the [`integration/flow`]
 ```sh
 npm run test
 ```
-
-## Maintainer
-
-Moritz Klack • [Twitter](https://twitter.com/moklick) • [Github](https://github.com/moklick)
-
-## Support
-
-If you need custom support or features for your application we are [happy to hear from you](https://webkid.io/contact).
-
-
-### Thanks!
-
-Special thanks to [Andy Lindemann](https://github.com/AndyLnd) for a lot of helpful contributions!
-
---
-
-React Flow is maintained by [webkid](https://webkid.io), a data visualization agency from Berlin. If you need help or want to develop react-based tools or data visualizations, [get in touch](https://webkid.io/contact)!