~wip

taoensso · Oct 2, 2024 · 8aa1cb7 · 8aa1cb7
1 parent e8c311f
commit 8aa1cb7
Showing 1 changed file with 53 additions and 47 deletions.
diff --git a/README.md b/README.md
@@ -45,7 +45,9 @@ It enables you to write code that is **information-verbose by default**.
 
 ## Quick examples
 
-```clojure
+<details>
+<summary>Create signals</summary>
+<pre lang="clojure"><code class="language-clojure">
 (require '[taoensso.telemere :as t])
 
 ;; (Just works / no config necessary for typical use cases)
@@ -87,7 +89,11 @@ It enables you to write code that is **information-verbose by default**.
 
   ;; Message string or vector to join as string
   ["Something interesting happened!" formatted])
+</code></pre></details>
 
+<details>
+<summary>Filter signals</summary>
+<pre lang="clojure"><code class="language-clojure">
 ;; Set minimum level
 (t/set-min-level!       :warn) ; For all    signals
 (t/set-min-level! :log :debug) ; For `log!` signals only
@@ -113,52 +119,11 @@ It enables you to write code that is **information-verbose by default**.
 (t/with-signal (t/event! ::my-id {:data {:skip-me? false}})) ; => {...}
 
 ;; See `t/help:filters` docstring for more filtering options
-```
+</code></pre></details>
 
-## Why Telemere?
-
-### Ergonomics
-
-- Elegant, lightweight API that's **easy to use**, **easy to configure**, and **deeply flexible**.
-- **Sensible defaults** to make getting started **fast and easy**.
-- Extensive **beginner-oriented** [documentation][GitHub wiki], [docstrings](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere), and error messages.
-
-### Interop
-
-- 1st-class **out-the-box interop** with [tools.logging](../../wiki/3-Config#toolslogging), [Java logging via SLF4J v2](../../wiki/3-Config#java-logging), [OpenTelemetry](../../wiki/3-Config#opentelemetry), and [Tufte](../../wiki/3-Config#tufte).
-- Included [shim](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere.timbre) for easy/gradual [migration from Timbre](../../wiki/5-Migrating).
-- Extensive set of [handlers](../../wiki/4-Handlers#included-handlers) included out-the-box.
-
-### Scaling
-
-- Hyper-optimized and **blazing fast**, see [performance](#performance).
-- An API that **scales comfortably** from the smallest disposable code, to the most massive and complex real-world production environments.
-- Auto [handler stats](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere#get-handlers-stats) for debugging performance and other issues at scale.
-
-### Flexibility
-
-- Config via plain **Clojure vals and fns** for easy customization, composition, and REPL debugging.
-- Unmatched [environmental config](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere#help:environmental-config) support: JVM properties, environment variables, or classpath resources. Per platform, or cross-platform.
-- Unmatched [filtering](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere#help:filters) support: by namespace, id pattern, level, level by namespace pattern, etc. At runtime and compile-time.
-- Fully [configurable](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere#help:handler-dispatch-options) **a/sync dispatch support**: blocking, dropping, sliding, etc.
-- Turn-key **sampling**, **rate-limiting**, and **back-pressure monitoring** with sensible defaults.
-
-## Comparisons
-
-- Telemere [compared](../../wiki/5-Migrating#from-timbre) to [Timbre](https://www.taoensso.com/timbre) (Telemere's predecessor)
-- Telemere [compared](../../wiki/6-FAQ#how-does-telemere-compare-to-mulog) to [Mulog](https://github.com/BrunoBonacci/mulog) (Structured micro-logging library)
-
-## Video demo
-
-See for intro and basic usage:
-
-<a href="https://www.youtube.com/watch?v=-L9irDG8ysM" target="_blank">
- <img src="https://img.youtube.com/vi/-L9irDG8ysM/maxresdefault.jpg" alt="Telemere demo video" width="480" border="0" />
-</a>
-
-## More examples
-
-```clojure
+<details>
+<summary>Adding handlers</summary>
+<pre lang="clojure"><code class="language-clojure">
 ;; Add your own signal handler
 (t/add-handler! :my-handler
   (fn
@@ -201,10 +166,51 @@ See for intro and basic usage:
     {:output-fn
      #?(:cljs :json ; Use js/JSON.stringify
         :clj   jsonista/write-value-as-string)}))
-```
+</code></pre></details>
 
 See [examples.cljc](https://github.com/taoensso/telemere/blob/master/examples.cljc) for REPL-ready snippets!
 
+## Why Telemere?
+
+### Ergonomics
+
+- Elegant, lightweight API that's **easy to use**, **easy to configure**, and **deeply flexible**.
+- **Sensible defaults** to make getting started **fast and easy**.
+- Extensive **beginner-oriented** [documentation][GitHub wiki], [docstrings](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere), and error messages.
+
+### Interop
+
+- 1st-class **out-the-box interop** with [tools.logging](../../wiki/3-Config#toolslogging), [Java logging via SLF4J v2](../../wiki/3-Config#java-logging), [OpenTelemetry](../../wiki/3-Config#opentelemetry), and [Tufte](../../wiki/3-Config#tufte).
+- Included [shim](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere.timbre) for easy/gradual [migration from Timbre](../../wiki/5-Migrating).
+- Extensive set of [handlers](../../wiki/4-Handlers#included-handlers) included out-the-box.
+
+### Scaling
+
+- Hyper-optimized and **blazing fast**, see [performance](#performance).
+- An API that **scales comfortably** from the smallest disposable code, to the most massive and complex real-world production environments.
+- Auto [handler stats](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere#get-handlers-stats) for debugging performance and other issues at scale.
+
+### Flexibility
+
+- Config via plain **Clojure vals and fns** for easy customization, composition, and REPL debugging.
+- Unmatched [environmental config](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere#help:environmental-config) support: JVM properties, environment variables, or classpath resources. Per platform, or cross-platform.
+- Unmatched [filtering](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere#help:filters) support: by namespace, id pattern, level, level by namespace pattern, etc. At runtime and compile-time.
+- Fully [configurable](https://cljdoc.org/d/com.taoensso/telemere/CURRENT/api/taoensso.telemere#help:handler-dispatch-options) **a/sync dispatch support**: blocking, dropping, sliding, etc.
+- Turn-key **sampling**, **rate-limiting**, and **back-pressure monitoring** with sensible defaults.
+
+## Comparisons
+
+- Telemere [compared](../../wiki/5-Migrating#from-timbre) to [Timbre](https://www.taoensso.com/timbre) (Telemere's predecessor)
+- Telemere [compared](../../wiki/6-FAQ#how-does-telemere-compare-to-mulog) to [Mulog](https://github.com/BrunoBonacci/mulog) (Structured micro-logging library)
+
+## Video demo
+
+See for intro and basic usage:
+
+<a href="https://www.youtube.com/watch?v=-L9irDG8ysM" target="_blank">
+ <img src="https://img.youtube.com/vi/-L9irDG8ysM/maxresdefault.jpg" alt="Telemere demo video" width="480" border="0" />
+</a>
+
 ## API overview
 
 See relevant docstrings (links below) for usage info-