From e56797c8ea2bba6000c49fd37d6339fe7a3d45fb Mon Sep 17 00:00:00 2001
From: pawurb <contact@pawelurbanek.com>
Date: Wed, 9 Oct 2024 11:15:03 +0200
Subject: [PATCH] Add example

---
 Cargo.toml              |  4 ++++
 README.md               |  6 ++----
 examples/db_settings.rs | 15 +++++++++++++++
 3 files changed, 21 insertions(+), 4 deletions(-)
 create mode 100644 examples/db_settings.rs

diff --git a/Cargo.toml b/Cargo.toml
index a9025fd..79b09cb 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -27,3 +27,7 @@ tokio = { version = "1.40", features = ["full"] }
 [[bin]]
 name = "pg_extras"
 path = "src/main.rs"
+
+[[example]]
+name = "db_settings"
+path = "examples/db_settings.rs"
diff --git a/README.md b/README.md
index 9094676..b163cfb 100644
--- a/README.md
+++ b/README.md
@@ -20,10 +20,8 @@ Alternative versions:
 
 ## Installation
 
-In your Cargo.toml
-
-```rust
-pg-extras = "0.4"
+```bash
+cargo add pg-extras
 ```
 
 `calls` and `outliers` queries require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension.
diff --git a/examples/db_settings.rs b/examples/db_settings.rs
new file mode 100644
index 0000000..6990846
--- /dev/null
+++ b/examples/db_settings.rs
@@ -0,0 +1,15 @@
+use pg_extras::{db_settings, render_table, PgExtrasError};
+
+#[tokio::main]
+
+async fn main() -> Result<(), PgExtrasError> {
+    std::env::set_var(
+        "PG_EXTRAS_DATABASE_URL",
+        "postgres://postgres:secret@localhost:5432/rust-pg-extras-test",
+    );
+
+    let settings = db_settings().await?;
+    render_table(settings);
+
+    Ok(())
+}