From 5acfacb885a1b4a4ec661f32c2dac457c7cc102c Mon Sep 17 00:00:00 2001 From: moklick Date: Wed, 23 Oct 2019 19:39:57 +0200 Subject: [PATCH] docs(readme): add example section --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a31a912d..95a7d1e1 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # :ocean: React Flow -React Flow is a library for building node-based graphs. You can easily implement custom node types and it comes with plugins like a MiniMap and a Controls Panel. +React Flow is a library for building node-based graphs. You can easily implement custom node types and it comes with plugins like a MiniMap and a Controls Panel. Check out the [demo](https://react-flow.netlify.com/) graph. - [Installation](#installation) - [Usage](#usage) @@ -16,6 +16,7 @@ React Flow is a library for building node-based graphs. You can easily implement - [Plugins](#plugins) - [Minimap](#minimap) - [Controls](#controls) +- [Examples](#examples) ## Installation @@ -194,3 +195,12 @@ const GraphWithControls = () => ( - `style`: css properties - `className`: class name + +## Examples + +You can find all examples in the [example](example) folder. They are also deployt: + +- [basic](https://react-flow.netlify.com/basic) +- [empty](https://react-flow.netlify.com/empty) +- [basic](https://react-flow.netlify.com/basic) +- [custom nodes](https://react-flow.netlify.com/)