New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a README #9

Open

6 tasks

addisonj opened this issue Oct 31, 2016 · 0 comments

Labels

docs

Milestone

Contributor

addisonj commented Oct 31, 2016 •

edited

Loading

We don't have one... This doesn't all need to be in the README (links to other docs would be great)

Should include:

General idea behind ftl-engine (pluggable graph execution)
Quick Start Example (with screencast/gif demo?)
More fleshed out example
Explaining graph generation (both what is included and how you could generate another way)
Activity plugins
Small description of how it works (SWF, S3 for claim check, etc)

Will update this list as gaps show up

addisonj modified the milestone: Docs

addisonj added the docs label

addisonj added this to the v1 Release milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment