Improve description and usage in README #27

Closed
bemson opened this Issue Mar 18, 2013 · 0 comments

Comments

Projects
None yet
1 participant
Owner

bemson commented Mar 18, 2013

The current README doesn't properly introduce Flow or give a decent overview of it's usage.

The README should remain short while including (at minimum) a description and usage section. The description should be no more than two paragraphs, and explain:

  1. What is Flow?
  2. Why is it novel?
  3. How does it work?

The usage section will contain a trivial walk-through of a code sample. The goal of the usage section is to demonstrate how Flow simplifies common procedural patterns.

This issue will be updated to capture possible starts to the primary README sections.

@ghost ghost assigned bemson Mar 18, 2013

@bemson bemson closed this in 7668008 Feb 1, 2014

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