Skip to content
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

Update README #13

Closed
5 tasks done
Tracked by #1
jessmartin opened this issue Jul 26, 2022 · 2 comments
Closed
5 tasks done
Tracked by #1

Update README #13

jessmartin opened this issue Jul 26, 2022 · 2 comments
Assignees
@jessmartin
Labels
documentation Improvements or additions to documentation
Milestone
0.2 Alpha 2

Comments

@jessmartin
Copy link
Contributor

jessmartin commented Jul 26, 2022 •
edited
Loading

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.
@jessmartin jessmartin added the documentation Improvements or additions to documentation label Jul 26, 2022
@jessmartin jessmartin mentioned this issue Jul 26, 2022
Closed
3 tasks
@jessmartin jessmartin added this to the 0.1 Alpha milestone Jul 26, 2022
@jeffgca jeffgca self-assigned this Aug 25, 2022
@jeffgca jeffgca modified the milestones: 0.1 Alpha, 0.2 Alpha 2 Sep 1, 2022
@jeffgca jeffgca mentioned this issue Sep 1, 2022
Open
16 tasks
@jessmartin jessmartin mentioned this issue Sep 15, 2022
Merged
1 task
@walkah walkah assigned jessmartin and unassigned jeffgca and bgins Oct 18, 2022
@jessmartin
Copy link
Contributor Author

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

@jessmartin
Copy link
Contributor Author

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

@walkah walkah closed this as completed Nov 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jessmartin jessmartin

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.2 Alpha 2
Development

No branches or pull requests
4 participants
@walkah @jessmartin @jeffgca @bgins