Skip to content

Comments

docs: preparing readme for public release#433

Merged
pavelfeldman merged 2 commits intomicrosoft:masterfrom
arjunattam:readme-2
Jan 9, 2020
Merged

docs: preparing readme for public release#433
pavelfeldman merged 2 commits intomicrosoft:masterfrom
arjunattam:readme-2

Conversation

@arjunattam
Copy link
Contributor

Preview readme is here: https://github.com/arjun27/playwright/blob/readme-2/README.md

This needs some more work—opening this to get suggestions. Things on my mind:

  • The Puppeteer comparison question in FAQs needs more work. Currently, it feels focused on the implementation and not on the value to users. To communicate that better, I'm wondering if we should have a basic list of features. This list of features could then be used for comparisons against other tools (Cypress/Selenium) or among browsers. I have a draft list of features below, but I would need your help for comprehensiveness.
  • Should we call out TypeScript as a differentiator with Puppeteer?
  • CI badges: they don't work right now, I'm expecting them to show the correct status when the GH workflows become public with the repo.
  • CI badges: our builds are failing, and it seems the issue is some rate limiting? Is there a way we could fix the build to pass before release?

Feature list

  • Accessibility
  • Emulation
  • Input (mouse, keyboard)
  • Generating PDFs, screenshots
  • Geolocation
  • Code coverage and performance metrics

(cherry picked from commit 230c22edc4750dad41055fab0ab276714896b0da)
@pavelfeldman
Copy link
Member

I would remove the mention of the studio since it is not yet public. Otherwise, looks good.

@pavelfeldman pavelfeldman merged commit 2f8049f into microsoft:master Jan 9, 2020
@pavelfeldman pavelfeldman deleted the readme-2 branch January 9, 2020 00:53
@chirag04
Copy link

This list of features could then be used for comparisons against other tools (Cypress/Selenium) or among browsers. I have a draft list of features below, but I would need your help for comprehensiveness.

@arjun27 comparison with cypress and other tools will greatly help with decision making for folks wanting to introduce this in their stack. (Not to say that's how one should make a decision to use such a tool or not)

sand4rt pushed a commit to sand4rt/playwright that referenced this pull request Dec 21, 2022
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
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

Successfully merging this pull request may close these issues.

3 participants