Update readme and docs

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "thirtyfour_query"
-version = "0.3.0"
+version = "0.3.1"
 authors = ["Steve Pryde <steve@stevepryde.com>"]
 edition = "2018"
 license = "MIT OR Apache-2.0"

README.md

@@ -7,6 +7,40 @@ Advanced element query interface for the thirtyfour crate.
 
 This crate is experimental and expected to have breaking changes often.
 
+## Usage
+
+With the new query interface you can do things like:
+
+```rust
+let elem_text = 
+    driver.query(By::Css("thiswont.match")).or(By::Id("searchInput")).first().await?;
+```
+
+This will execute both queries once per poll iteration and return the first one that matches.
+You can also filter on one or both match arms like this:
+
+```rust
+driver.query(By::Css("thiswont.match")).with_text("testing")
+    .or(By::Id("searchInput")).with_class("search").and_not_enabled()
+    .first().await?;
+```
+
+To fetch all matching elements instead of just the first one, simply change first() to all() 
+and you'll get a Vec instead. This will never return an empty Vec. If either first() or all() 
+don't match anything, you'll get `WebDriverError::NoSuchElement` instead. 
+The error message will show the selectors used.
+
+To set up default polling for all elements, do this:
+```rust 
+// Disable implicit timeout in order to use new query interface.
+driver.set_implicit_wait_timeout(Duration::new(0, 0)).await?;
+
+let poller = ElementPoller::Time(Duration::new(20, 0), Duration::from_millis(500));
+driver.config_mut().set("ElementPoller", poller)?;
+```
+
+Other ElementPoller options are also available, such as NoWait and NumTries.
+
 ## LICENSE
 
 This work is dual-licensed under MIT or Apache 2.0.

src/lib.rs

@@ -3,7 +3,43 @@
 //!
 //! See examples for more details.
 //!
+//! ## Experimental
+//!
 //! This crate is still experimental and expected to have breaking changes often, however
 //! the basic interface is working.
+//!
+//! ## Usage
+//!
+//! With the new query interface you can do things like:
+//!
+//! ```no_run
+//! let elem_text =
+//!     driver.query(By::Css("thiswont.match")).or(By::Id("searchInput")).first().await?;
+//! ```
+//!
+//! This will execute both queries once per poll iteration and return the first one that matches.
+//! You can also filter on one or both match arms like this:
+//!
+//! ```no_run
+//! driver.query(By::Css("thiswont.match")).with_text("testing")
+//!     .or(By::Id("searchInput")).with_class("search").and_not_enabled()
+//!     .first().await?;
+//! ```
+//!
+//! To fetch all matching elements instead of just the first one, simply change first() to all()
+//! and you'll get a Vec instead. This will never return an empty Vec. If either first() or all()
+//! don't match anything, you'll get `WebDriverError::NoSuchElement` instead.
+//! The error message will show the selectors used.
+//!
+//! To set up default polling for all elements, do this:
+//! ```no_run
+//! // Disable implicit timeout in order to use new query interface.
+//! driver.set_implicit_wait_timeout(Duration::new(0, 0)).await?;
+//!
+//! let poller = ElementPoller::Time(Duration::new(20, 0), Duration::from_millis(500));
+//! driver.config_mut().set("ElementPoller", poller)?;
+//! ```
+//!
+//! Other ElementPoller options are also available, such as NoWait and NumTries.
 
 pub mod query;