From 45988211c7ccf7daa5063170302ffdbf32d3f900 Mon Sep 17 00:00:00 2001
From: Roland Conybeare <rconybeare@gmail.com>
Date: Mon, 11 Sep 2023 16:10:50 -0400
Subject: [PATCH] doc: README.md example

---
 README.md | 32 +++++++++++++++++++++++++++++++-
 1 file changed, 31 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 829204dd..261399f8 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,31 @@
-# nestlog
+# nestlog -- logging with automatic indenting according to call graph
+
+Nestlog is a lightweight header-only library for console logging.
+
+## Examples
+
+    ```
+    /* examples/ex1/ex1.cpp */
+
+    #include "nestlog/scope.hpp"
+
+    using namespace xo;
+
+    void A(int x) {
+        XO_SCOPE(log)  // i.e. xo::scope log("A");
+
+        log(":x ", x);
+    }
+
+    int
+    main(int argc, char ** argv) {
+        A(66);
+    }
+    ```
+
+  output:
+    ```
+    +A
+      :x 66
+    -A
+    ```