CARS-29365: fix documentation (#9)

Author: martin-dessureault

CHANGELOG.md

@@ -7,6 +7,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+## [Unreleased]
+
+### Documentation
+
+- Updated version references in README from `0.2` to `0.3`
+- Fixed broken image reference in README (removed non-existent `assets/logo.png`)
+- Added Telemetry section to README documenting the `[:req_fuse, :blown]` event
+- Updated CHANGELOG with missing entries for versions 0.3.0 and 0.3.2
+- Fixed typo in mix.exs description (`ttps://` → `https://`)
+
+## [0.3.2](https://github.com/carsdotcom/req_fuse/compare/0.3.0...0.3.2) - 2025-03-20
+
+### Merged
+
+- Update mix.lock with latest package versions [`#8`](https://github.com/carsdotcom/req_fuse/pull/8)
+- Bump ex_doc for fix warnings [`#7`](https://github.com/carsdotcom/req_fuse/pull/7)
+- Upgrade req and its dependencies [`#6`](https://github.com/carsdotcom/req_fuse/pull/6)
+
+## [0.3.0](https://github.com/carsdotcom/req_fuse/compare/0.2.3...0.3.0) - 2024-04-04
+
+### Merged
+
+- Upgrade to Req 0.4.14 which introduces improved testing mechanism [`#5`](https://github.com/carsdotcom/req_fuse/pull/5)
+
+### Commits
+
+- update test setup to match Req changes [`f17e789`](https://github.com/carsdotcom/req_fuse/commit/f17e789)
+- update req and finch [`bb005f4`](https://github.com/carsdotcom/req_fuse/commit/bb005f4)
+
 ## [0.2.3](https://github.com/carsdotcom/req_fuse/compare/0.2.2...0.2.3) - 2023-04-18
 
 ### Commits

README.md

@@ -1,8 +1,6 @@
 # ReqFuse
 
-<object data="assets/logo.png" type="image/jpeg">
-  <img src="assets/fuse.png" alt="ReqFuse fuses" />
-</object>
+<img src="assets/fuse.png" alt="ReqFuse fuses" />
 
 ReqFuse on Github https://github.com/carsdotcom/req_fuse
 
@@ -27,7 +25,7 @@ you are passing in the required and any optional fuse configuration.
 ```elixir
 Mix.install([
   {:req, "~> 0.3"},
-  {:req_fuse, "~> 0.2"}
+  {:req_fuse, "~> 0.3"}
 ])
 
 req_fuse_opts = [fuse_name: My.Example.Fuse]
@@ -51,7 +49,7 @@ by adding `req_fuse` to your list of dependencies in `mix.exs`:
 ```elixir
 def deps do
   [
-    {:req_fuse, ">= 0.2.0"}
+    {:req_fuse, ">= 0.3.0"}
   ]
 end
 ```
@@ -79,6 +77,31 @@ strategies and their options.
 
 See also the additional discussion on options in `ReqFuse.Steps.Fuse`
 
+## Telemetry
+
+ReqFuse emits telemetry events for observability:
+
+### Events
+
+* `[:req_fuse, :blown]` - Emitted when a request is blocked because the fuse is blown (circuit breaker is open).
+
+#### Metadata
+
+* `:fuse_name` - The name of the fuse that is blown.
+
+### Example Handler
+
+```elixir
+:telemetry.attach(
+  "req-fuse-handler",
+  [:req_fuse, :blown],
+  fn _event, _measurements, metadata, _config ->
+    Logger.warning("Circuit breaker open for #{inspect(metadata.fuse_name)}")
+  end,
+  nil
+)
+```
+
 ## License
 
   See [LICENSE](https://github.com/carsdotcom/req_fuse/blob/main/LICENSE)

mix.exs

@@ -49,7 +49,7 @@ defmodule ReqFuse.MixProject do
     """
     ReqFuse provides circuit-breaking functionality, using fuse, for HTTP requests that use Req.
     Req: https://github.com/wojtekmach/req
-    Fuse: ttps://github.com/jlouis/fuse
+    Fuse: https://github.com/jlouis/fuse
     """
   end