Add docs

Author: AB-xdev

CHANGELOG.md

@@ -0,0 +1,2 @@
+# 1.0.0
+_Initial release_

README.md

@@ -4,6 +4,69 @@
 
 # <img src="https://raw.githubusercontent.com/SeleniumHQ/seleniumhq.github.io/690acbad7b4bf4656f116274809765db64e6ccf7/website_and_docs/static/images/logos/webdriver.svg" height=24 /> Elements for Selenium
 
+Define Selenium HTML elements as Java classes, similar to Selenium's ``@FindBy`` annotation.
+
+Also contains a ton of other predefined utility, for example:
+* Automatically scrolling elements that perform operations into the view
+* Safe click: When an element is detected as stale a JavaScript click is executed instead
+* Option to globally wait until the page finished loading
+* Waiting for some time until the element is present (``waitUntil``)
+
+Overall this improves:
+* Less [flaky](https://www.browserstack.com/test-reporting-and-analytics/features/test-reporting/what-is-flaky-test) tests
+* Abstraction of elements in an object oriented way
+
+## Usage
+
+1. Define the elements you want to access
+    ```java
+    @FindBySelector(tagName = "body")
+    abstract class BodyElement implements ImprovedWebElement {
+        public MyElement myElement() {
+            return waitForFirst(MyElement.class);
+        }
+    }
+
+    @FindBySelector(id = "abc")
+    abstract class MyElement implements ImprovedWebElement {
+    }
+    ```
+2. Utilize the predefined methods and classes to get/access the elements in a test
+    ```java
+    class MyWebDriverTest implements CanFindElements {
+        WebDriver webDriver;
+
+        @BeforeEach
+        void beforeEach() {
+            webDriver = createWebDriver();
+            CustomizableRemoteWebElementInstaller.install(
+                webDriver,
+                () -> new ImprovedRemoteWebElement(
+                    "return document.readyState == 'complete';")
+            );
+        }
+
+        @Test
+        void test() {
+            MyElement myElement = waitForFirst(BodyElement.class).myElement();
+            assertEquals("Hello world", myElement.getText());
+
+            // Or alternatively
+            ElementInstantiatorInstance.instance().find(webDriver, BodyElement.class);
+        }
+
+        @AfterEach
+        void afterEach() {
+            // Stop webDriver here...
+            webDriver = null;
+        }
+
+        @Override
+        public WebDriver getWebDriver() {
+            return webDriver;
+        }
+    }
+    ```
 
 ## Installation
 [Installation guide for the latest release](https://github.com/xdev-software/selenium-elements/releases/latest#Installation)

selenium-elements/src/test/java/software/xdev/selenium/elements/SimpleContainerTest.java

@@ -53,10 +53,7 @@ void simpleCheck(final Capabilities capabilities)
 
 			CustomizableRemoteWebElementInstaller.install(
 				this.remoteWebDriver,
-				() -> new ImprovedRemoteWebElement("if (document.readyState != 'complete') {"
-					+ "  return false;"
-					+ "}"
-					+ "return true;"));
+				() -> new ImprovedRemoteWebElement("return document.readyState == 'complete';"));
 
 			this.remoteWebDriver.manage().window().maximize();
 			this.remoteWebDriver.get(capabilities instanceof FirefoxOptions ? "about:support" : "chrome://version");