Skip to content

Commit

Permalink
Add logo to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
erwinvaneyk committed Jan 21, 2018
1 parent 277bd2a commit c6b134e
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
Binary file added Docs/assets/fission-workflows-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Docs/assets/workflow-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@
[![Build Status](https://travis-ci.org/fission/fission-workflows.svg?branch=master)](https://travis-ci.org/fission/fission-workflows)
[![Go Report Card](https://goreportcard.com/badge/github.com/fission/fission-workflows)](https://goreportcard.com/report/github.com/fission/fission-workflows)
[![Fission Slack](http://slack.fission.io/badge.svg)](http://slack.fission.io)
[![fission.io](https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=fission.io)](http://fission.io)
[![@fissionio](https://img.shields.io/twitter/follow/fissionio.svg?style=social&label=Follow)](https://twitter.com/fissionio)

[fission.io](http://fission.io) [@fissionio](http://twitter.com/fissionio)
[![Fission Workflows](Docs/assets/fission-workflows-logo.png)](http://fission.io/workflows)

----

Fission Workflows is a workflow-based serverless function composition framework built on top of the [Fission](https://github.com/fission/fission) Function-as-a-Service (FaaS) platform.

Expand All @@ -14,6 +18,8 @@ Fission Workflows is a workflow-based serverless function composition framework
- **Extensible**: All main aspects of the engine are extensible. For example, you can even define your own control flow constructs.
- **Lightweight**: With just the need for a single data store (NATS Streaming) and a FaaS platform (Fission), the engine consumes minimal resources.

----

### Philosophy

The Fission Functions-as-a-Service framework provides simplicity and
Expand Down Expand Up @@ -50,11 +56,8 @@ most other workflow engines are part of the internal API.

**Workflows** can generally be represented in as a Directed Acyclic Graph (DAG).
Consider the following example, a common pattern, the diamond-shaped workflow:
```
(A) --> (B) ---> (C) ---
\ \
--> (D) ----> (E) ---> (F)
```

![Workflow Example](Docs/assets/workflow-example.png)

In this graph there is a single _starting task_ A, a _scatter task_ B
triggering parallel execution of two _branches_ with tasks C and D,
Expand All @@ -63,7 +66,7 @@ parallel tasks.

Finally the graph concludes once _final task_ F has been completed.

Although Fission Workflow has additional functionality such as
Although Fission Workflows has additional functionality such as
conditional branches and advanced control flow options, it
fundamentally executes a dependency graph.

Expand Down Expand Up @@ -150,7 +153,7 @@ issues, checkout the [roadmap](./Docs/roadmap.md) or browse through
the open issues on Github.

Finally, we're looking for early developer feedback -- if you do use
Fission or Fission Workflow, we'd love to hear how it's working for
Fission or Fission Workflows, we'd love to hear how it's working for
you, what parts in particular you'd like to see improved, and so on.

Talk to us on [slack](http://slack.fission.io) or
Expand Down

0 comments on commit c6b134e

Please sign in to comment.