From ae04b5a07f89d4f25834cc45b87f7c83ad22609f Mon Sep 17 00:00:00 2001 From: Dylan Vorster Date: Sat, 17 Mar 2018 12:26:03 +0000 Subject: [PATCH] Updates README.md Auto commit by GitBook Editor --- README.md | 43 +++++++++++-------------------------------- 1 file changed, 11 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index fefdb76..d601c43 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ # STORM React Diagrams -__DEMO__: http://www.projectstorm.io/react-diagrams +**DEMO**: [http://www.projectstorm.io/react-diagrams](http://www.projectstorm.io/react-diagrams) -__RELEASE NOTES__ : http://dylanv.blog/2018/03/03/storm-react-diagrams-5-0-0/ +**DOCS:** [https://projectstorm.gitbooks.io/react-diagrams](https://projectstorm.gitbooks.io/react-diagrams) + +**RELEASE NOTES** : [http://dylanv.blog/2018/03/03/storm-react-diagrams-5-0-0/](http://dylanv.blog/2018/03/03/storm-react-diagrams-5-0-0/) A super simple, no-nonsense diagramming library written in React that just works. -[![Join the chat at https://gitter.im/projectstorm/react-diagrams](https://badges.gitter.im/projectstorm/react-diagrams.svg)](https://gitter.im/projectstorm/react-diagrams?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -[![NPM](https://img.shields.io/npm/v/storm-react-diagrams.svg)](https://npmjs.org/package/storm-react-diagrams) -[![NPM](https://img.shields.io/npm/dt/storm-react-diagrams.svg)](https://npmjs.org/package/storm-react-diagrams) +[![Join the chat at https://gitter.im/projectstorm/react-diagrams](https://badges.gitter.im/projectstorm/react-diagrams.svg)](https://gitter.im/projectstorm/react-diagrams?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![NPM](https://img.shields.io/npm/v/storm-react-diagrams.svg)](https://npmjs.org/package/storm-react-diagrams) +[![NPM](https://img.shields.io/npm/dt/storm-react-diagrams.svg)](https://npmjs.org/package/storm-react-diagrams)![](https://www.gitbook.com/button/status/book/projectstorm/react-diagrams) [![CircleCI](https://circleci.com/gh/projectstorm/react-diagrams/tree/master.svg?style=svg)](https://circleci.com/gh/projectstorm/react-diagrams/tree/master) ![Personal Project](./images/example1.png) @@ -22,45 +24,22 @@ A super simple, no-nonsense diagramming library written in React that just works A no-nonsense diagramming library written entirely in React with the help of a few small libraries. It aims to be: * Simple, and void of any fuss/complications when implementing it into your own application -* Customizable without having to hack the core (adapters/factories etc..) +* Customizable without having to hack the core \(adapters/factories etc..\) * Simple to operate and understand without sugar and magic * Fast and optimized to handle large diagrams with hundreds of nodes/links * Super easy to use, and should work as you expect it to * Perfect for creating declarative systems such as programmatic pipelines and visual programming languages -## Usage - -#### Installing - -`npm install storm-react-diagrams` or `yarn add storm-react-diagrams` - -#### Getting started - -The best place to start is by looking at the simple demos `demos/demo-simple` and going from there. - #### Run the demos After running `yarn install` you must then run: `yarn run storybook` #### Building from source -Simply run ```webpack``` in the root directory (or ```export NODE_ENV=production && webpack``` if you want a production build) and it will spit out the transpiled code and typescript definitions into the dist directory as a single file. -We use webpack for this because TSC cannot compile a single UMD file (TSC can currently only output multiple UMD files). +Simply run `webpack` in the root directory \(or `export NODE_ENV=production && webpack` if you want a production build\) and it will spit out the transpiled code and typescript definitions into the dist directory as a single file. +We use webpack for this because TSC cannot compile a single UMD file \(TSC can currently only output multiple UMD files\). - -## Make your own nodes - -To see how to create your own nodes like the one below, take a look at __demos/demo-custom-link1__: - -![Demo2](./images/demo3.png) - -## Learn More - -[Architecture Questions](docs/Architecture%20Questions.md) - -[Interactive Questions](docs/Interactive%20Usage.md) - -[Testing the Library](docs/Testing.md) +## [Checkout the docs](https://projectstorm.gitbooks.io/react-diagrams)