diff --git a/SUMMARY.md b/SUMMARY.md new file mode 100644 index 0000000..a6e74ef --- /dev/null +++ b/SUMMARY.md @@ -0,0 +1,11 @@ +# Summary + +* [Introduction](README.md) +* [Interacting with diagrams](/docs/Interactive Usage.md) +* [Getting Started](/docs/Getting Started.md) +* [About the project](about-the-project.md) + * [Testing](/docs/Testing.md) + * [Architecture Questions](/docs/Architecture Questions.md) + + + diff --git a/about-the-project.md b/about-the-project.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/Getting Started.md b/docs/Getting Started.md new file mode 100644 index 0000000..6602b8a --- /dev/null +++ b/docs/Getting Started.md @@ -0,0 +1,142 @@ +# Getting started + +## Installation via NPM + +The first thing you need to do, is grab the distribution files on NPM. You can do this either using yarn or npm + +**Via yarn:** + +``` +yarn install storm-react-diagrams +``` + +**Via npm:** + +``` +npm install storm-react-diagrams +``` + +When you run this in your project directory, this will install the library into node\_modules/storm-react-diagrams. You will then find a dist folder that contains all the minified and production ready code. + +This will also install React and a few other dependencies that you need in order to use this library. + +## Including the library + +When including the library you will need both the javascript files as well as the raw BEM styles. Both are included in the dist folder and there are numerous ways to integrate them into your project: + +#### Getting the javascript files + +**Using Typescript / ES6: \(recommended\)** + +```js +import * as SRD from "storm-react-diagrams" +``` + +**Using RequireJS:** + +```js +var SRD = require("storm-react-diagrams) +``` + +**As a script tag \(not recommended\)** + +```html + + +