Skip to content

Commit

Permalink
docs(readme): add example section
Browse files Browse the repository at this point in the history
  • Loading branch information
moklick committed Oct 23, 2019
1 parent 1fbc06a commit 5acfacb
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down Expand Up @@ -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/)

0 comments on commit 5acfacb

Please sign in to comment.