Merge pull request #40 from RossRogers/master

Add simple example usage in README and in example directory

.github/workflows/ci.yml

@@ -42,4 +42,4 @@ jobs:
 
       - uses: taiki-e/install-action@cargo-hack
       - name: Build crate
-        run: cargo hack --feature-powerset build
+        run: cargo hack --feature-powerset check --all-targets

README.md

@@ -8,3 +8,17 @@ to [diesel](https://diesel.rs/), the safe, extensible ORM and query builder for
 
 This crate also serves as an example of how to extend diesel with database specific features
 outside of diesel itself as third party crate.
+
+
+## Example Usage
+
+```rust
+
+use diesel_full_text_search::*;
+
+let search = "bar";
+
+let query = foo::table.filter(to_tsvector(Foo::description).matches(to_tsquery(search)));
+```
+
+For complete examples, see [/examples](./examples).

examples/simple.rs

@@ -0,0 +1,24 @@
+extern crate diesel;
+use diesel::*;
+
+extern crate diesel_full_text_search;
+use diesel_full_text_search::*;
+
+type DB = diesel::pg::Pg;
+
+diesel::table! {
+    foo (id) {
+        id -> Int4,
+        description -> Text,
+    }
+}
+
+fn main() {
+    let search = "bar";
+
+    let query = foo::table.filter(to_tsvector(foo::description).matches(to_tsquery(search)));
+
+    let sql = debug_query::<DB, _>(&query).to_string();
+
+    println!("The sql code for `query` is:\n  {sql}\n");
+}