+
+
+
+
+
+
+ Introduction • + How To Use • + Acknowledgments +
-Here is a [youtube video](https://www.youtube.com/watch?v=78CgV46OstI) of Spring Flo in action. +## Introduction -## Consuming Spring Flo +**Spring Flo** is a JavaScript library that offers a basic embeddable HTML5 visual builder for pipelines and simple graphs. +This library is used as the basis of the stream builder in **Spring Cloud Data Flow**. + +[](https://cloud.spring.io/spring-cloud-dataflow/) + +Here is a [youtube video](https://www.youtube.com/watch?v=78CgV46OstI) of **Spring Flo** in action. + +--- + +## How To Use Refer to the [wiki](https://github.com/spring-projects/spring-flo/wiki) for more information on how to embed it in an application. -## Build +Please ensure that at a minimum [Node.js][], [npm][] and the [Angular CLI][] are available on your system. In order to execute the build simply do: -Spring Flo is built using NPM commands. Simplest way to build is via `npm run build` to build the project and run the tests (Prerequisite for th build is `npm install` executed before the build command is). Build results are produced under the __dist__ folder. + $ git clone https://github.com/spring-projects/spring-flo.git + $ npm install + $ npm run build + +Build results are produced under the __dist__ folder. -## Getting Help +A small self contained sample usage of **Spring Flo** is available in the [demo](https://github.com/spring-projects/spring-flo/tree/master/src/demo) sub folder. Execute `npm start` to run the sample. +The [Spring Cloud Data Flow UI](https://github.com/spring-cloud/spring-cloud-dataflow-ui) at github shows a larger scale usage of **Spring Flo**. -If you have any questions, issues, feedback or feature request please [raise an issue](https://github.com/spring-projects/spring-flo/issues). - -## Samples - -A small self contained sample usage of Spring Flo is available in the [demo](https://github.com/spring-projects/spring-flo/tree/master/src/demo) sub folder. Execute `npm start` to run the sample. The [Spring Cloud Data Flow UI](https://github.com/spring-cloud/spring-cloud-dataflow-ui) at github shows a larger scale usage of Spring Flo. - -## Contributing +**Spring Flo** is Open Source software released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html). Pull requests are welcome, but before accepting them we will need you to sign the [Contributors Agreement](https://support.springsource.com/spring_committer_signup). -## License +--- -Spring Flo is Open Source software released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html). +## Acknowledgments + +This project uses code from several open source packages: +[JointJS](https://www.jointjs.com/), +[CodeMirror](https://codemirror.net/) (...). + +This project is powered by: + +
+
+[Angular]: https://angular.io/
+[Angular CLI]: https://cli.angular.io/
+[Node.js]: https://nodejs.org/
+[npm]: https://www.npmjs.com/
diff --git a/docs/Flo.png b/docs/Flo.png
deleted file mode 100644
index 66e2ab7..0000000
Binary files a/docs/Flo.png and /dev/null differ
diff --git a/docs/flo.png b/docs/flo.png
new file mode 100644
index 0000000..9d2d4cb
Binary files /dev/null and b/docs/flo.png differ
diff --git a/docs/logo.png b/docs/logo.png
new file mode 100644
index 0000000..67c2a7b
Binary files /dev/null and b/docs/logo.png differ
+ 
+