Merge pull request #62 from oodamien/gh-readme

Update readme
This commit is contained in:
Alex Boyko
2020-01-10 14:07:31 -05:00
committed by GitHub
4 changed files with 55 additions and 18 deletions

View File

@@ -1,33 +1,70 @@
# Spring Flo
[![macOS Build Status](https://travis-ci.org/spring-projects/spring-flo.svg?branch=master)](https://travis-ci.org/spring-projects/spring-flo) [![Dependency Status](https://david-dm.org/spring-projects/spring-flo.svg)](https://david-dm.org/spring-projects/spring-flo)
<p align="center">
<a href="https://cloud.spring.io/spring-cloud-dataflow/">
<img alt="Spring Flo" title="Spring Flo" src="docs/logo.png" width="450">
</a>
</p>
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.
<p align="center">
<a href="https://travis-ci.org/spring-projects/spring-flo">
<img src="https://travis-ci.org/spring-projects/spring-flo.svg?branch=master"
alt="macOS Build Status">
</a>
<a href="https://david-dm.org/spring-projects/spring-flo">
<img src="https://david-dm.org/spring-projects/spring-flo.svg"
alt="Dependency Status">
</a>
</p>
[![dataflow ui](docs/Flo.png)](https://cloud.spring.io/spring-cloud-dataflow/)
<p align="center">
<a href="#introduction">Introduction</a> •
<a href="#how-to-use">How To Use</a> •
<a href="#acknowledgments">Acknowledgments</a>
</p>
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**.
[![dataflow ui](docs/flo.png)](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:
<a href="https://pivotal.io/"><img alt="Pivotal" width="136" title="Pivotal" src="https://i.imgur.com/XPeBw7A.png"></a> <a href="https://spring.io/"><img alt="Spring" title="Spring" src="https://i.imgur.com/az8Xady.png" width="155"></a>
[Angular]: https://angular.io/
[Angular CLI]: https://cli.angular.io/
[Node.js]: https://nodejs.org/
[npm]: https://www.npmjs.com/

Binary file not shown.

Before

Width:  |  Height:  |  Size: 104 KiB

BIN
docs/flo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 229 KiB

BIN
docs/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB