Skip to content

Minor rewordings #455

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+3 −5
Open

Minor rewordings #455

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2268992
Minor rewordings
ThomasLandauer Apr 14, 2021
6480d45
Update README.md
ThomasLandauer Jul 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,6 @@ Use [Composer](https://getcomposer.org/) to install Panther in your project. You

### Installing ChromeDriver and geckodriver

Panther uses the WebDriver protocol to control the browser used to crawl websites.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why should we delete this? It's an important information.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A quick Ctrl+F for "webdriver" gives me:

  • It leverages the W3C's WebDriver protocol
  • $client->getWebDriver()->manage()->getLog('browser');
  • client->getWebDriver()->manage()->getLog('performance');
  • Checking the State of the WebDriver Connection
  • Use the Client::ping() method to check if the WebDriver connection is still active
  • because this library uses WebDriverElement internally
  • Panther is built on top of PHP WebDriver

So if you merge this, it will still be explained 7 times :-)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's stated only one time that it's a W3C spec and it's an important information (especially because there are several things named WebDriver).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, I don't see your point.

It's stated only one time that it's a W3C spec

Well, but the sentence I deleted doesn't contain that! ;-)
Besides, the "installation" section just isn't the right place to inform people what this project is all about. This should be explained at the very top, and the third sentence on the page does this very clear IMO:

It leverages the W3C's WebDriver protocol to drive native web browsers such as Google Chrome and Firefox.


On all systems, you can use `dbrekelmans/browser-driver-installer` to install ChromeDriver and geckodriver locally:

composer require --dev dbrekelmans/bdi
Expand All @@ -68,9 +66,9 @@ On Windows, using [chocolatey](https://chocolatey.org):

choco install chromedriver selenium-gecko-driver

Finally, you can download manually [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/) (for Chromium or Chrome)
and [GeckoDriver](https://github.com/mozilla/geckodriver) (for Firefox) and put them anywhere in your `PATH`
or in the `drivers/` directory of your project.
Finally, you can manually download [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/) (for Chromium or Chrome)
or [GeckoDriver](https://github.com/mozilla/geckodriver) (for Firefox) and add them to your `PATH` or put them
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and is better (you may need both).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I changed it to "and/or", since not everybody needs both. OK?

in the `drivers/` directory of your project.

#### Registering the PHPUnit Extension

Expand Down