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.

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

Improve overall documentation #31

Open
andywer opened this issue Oct 18, 2019 · 0 comments
Open

Improve overall documentation #31

andywer opened this issue Oct 18, 2019 · 0 comments
Labels
documentation Improve documentation

Comments

@andywer
Copy link
Owner

andywer commented Oct 18, 2019

  • Rewrite readme
  • Add more markdown documents: Samples, recipes, detailed usage
  • Document CLI usage in readme
  • Logical flow: Install, run script file, run HTML file, explain window.headless, explain plugins, explain render plugin
  • Recipes: Run script, run mocha test, test web workers, screenshot website, debug
@andywer andywer added the documentation Improve documentation label Oct 18, 2019
@andywer andywer changed the title Improve readme Improve overall documentation Oct 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve documentation
Projects
None yet
Development

No branches or pull requests

1 participant