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

Make a sane README.md #7

Closed
aslushnikov opened this issue Jun 14, 2017 · 3 comments
Closed

Make a sane README.md #7

aslushnikov opened this issue Jun 14, 2017 · 3 comments

Comments

@aslushnikov
Copy link
Contributor

There should be a nice README which

  • explains Puppeteer's motivation and goals
  • provides FAQ
  • points to other useful resources, such as API documentation
@aslushnikov
Copy link
Contributor Author

@ebidel, I've updated README.md in 10e28a9 to make it more relevant. There are still a few TODO's left here and there. Let me know if you have any ideas how it could be further improved!

@ebidel
Copy link
Contributor

ebidel commented Jun 20, 2017

Still needs more love, but I did some basic polish in https://github.com/GoogleChrome/puppeteer/pulls.

@paulirish paulirish added this to the v0.1 milestone Jun 27, 2017
aslushnikov added a commit that referenced this issue Jul 28, 2017
Leave only essential information in the README.md

References #7
@aslushnikov
Copy link
Contributor Author

This seems to be good enough, closing this. If there are any concerns, feel free to submit an issue / PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants