diff --git a/README.adoc b/README.adoc deleted file mode 100644 index a337a96..0000000 --- a/README.adoc +++ /dev/null @@ -1,41 +0,0 @@ -= TabDriver - -:stylesheet: ../shared/adoc-styles.css -:toc: -:toclevels: 4 - - -* Wrapper for `selenium` to make it easier to use. -* Must use `Chrome` (not `Chromium`). -* Must supply `.properties` file with. - - - chrome.driver.path= - headless=false - download.dir= - -== Usage - -=== Init - -[source,java] -var confPath = Path.of("/foo/tabdriver.properties"); -var td = TabDriverBuilder.build(confPath); - -=== Web Navigation - -* `TabDriver` is somewhat opionionated. -* The default way of fetching an element is by `css` selector. -** i.e. `td.findByCss("input[name='q']")` -** this returns an `Optional` which the consumer can -** the optional is empty on any error. -decide how to consume. - -=== Quick Recap of CSS Selectors - -|=== -| Selector | Description -| `[class*='x']` , `[aria-label*='x']` | `attribute` containing `x` -| button[class*='email'] | button with a class containing the word `email` -| form[action*='sign'] | form with an action attribute containing the word `sign` -| button.tv-button#email-signin | button with class `tv-button` and id `email-signin` diff --git a/README.md b/README.md new file mode 100644 index 0000000..dae16fc --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# TabDriver + + +* Wrapper for `selenium` to make it easier to use. +* Must use `Chrome` (not `Chromium`). +* Must supply `.properties` file with. + +```properties +chrome.driver.path= +headless=false +download.dir= +``` + +## Usage + +### Init + +```java +var confPath = Path.of("/foo/tabdriver.properties"); +var td = TabDriverBuilder.build(confPath); +``` + +### Web Navigation + +* `TabDriver` is somewhat opionionated. +* The default way of fetching an element is by `css` selector. + * i.e. `td.findByCss("input[name='q']")` + * this returns an `Optional` which the consumer can decide how to consume. + * the optional is empty on any error. + + +### Quick Recap of CSS Selectors + +| Selector | Description | +|--------------------------------------|----------------------------------------------------------| +| `[class*='x']` , `[aria-label*='x']` | `attribute` containing `x` | +| button[class*='email'] | button with a class containing the word `email` | +| form[action*='sign'] | form with an action attribute containing the word `sign` | +| button.tv-button#email-signin | button with class `tv-button` and id `email-signin` | diff --git a/pom.xml b/pom.xml index b74cca2..0857d62 100644 --- a/pom.xml +++ b/pom.xml @@ -5,35 +5,31 @@ com.olexyn min-root - jdk17-0.0 + 17.0.1 tabdriver - 1.3.1 + 1.3.2 jar - - tabdriver - 4.21.0 0.9.7376 - com.olexyn min-bom - jdk17-0.3 + 17.0.6 pom import - com.olexyn min-log + 0.6 @@ -74,16 +70,13 @@ com.olexyn min-prop + 2.2.2 org.junit.jupiter junit-jupiter - RELEASE + 5.11.3 test - - - -