oddsdk/odd-app-template

Update README

Closed this issue · 2 comments

Motivation

The purpose of this application is to provide a starting point for developers to build applications with WebNative. Additionally, they will need to learn about some of the WebNative concepts in order to build the application. We need to have a comprehensive README that walks developers through the template application's features and highlights key WebNative concepts.

Finish Line

  • Overview / header: a nice header and summary statement. One-liner describing what it is.
  • Screenshot showing off the UI?
  • Getting Started: should walk the developer through cloning, getting it running, and customizing the application to their needs, including renaming the appropriate things
    • Requirements: Minimum node version, etc
  • Add disclaimer that the WAT is currently experimental and should not be used for production apps.

Blocked by #14. Once the Fission Guide is complete, we'll bring some of that copy into the README.

Dunzo! Moved some of the "new Webnative APIs" out to #86