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

Make README amazing #5

Open
6 tasks
lastmjs opened this issue Nov 4, 2016 · 0 comments
Open
6 tasks

Make README amazing #5

lastmjs opened this issue Nov 4, 2016 · 0 comments
Milestone
Before the articl...

Comments

@lastmjs
Copy link
Member

lastmjs commented Nov 4, 2016 •
edited by electrovir
Loading

Once we have our prototypes working and we are ready for the world to begin using the components, make the README amazing. Make it very simple, effective, and useful.

  • High level description to help people quickly understand the power of the components
  • Quick example to show how easy it is to use the components to build applications
  • Installation
  • Use
  • Documentation for each component, we might want a separate website for documentation (properties, methods, events)
  • Acknowledgements
@lastmjs lastmjs added this to the Prototype milestone Nov 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Before the article is released
Development

No branches or pull requests
1 participant
@lastmjs