From ef28d8367fee9e4f40effb47a74d37c9cd95839d Mon Sep 17 00:00:00 2001
From: "D. Scott Boggs" <scott@tams.tech>
Date: Sat, 21 Jan 2023 05:33:41 -0500
Subject: [PATCH] Add note pointing to more complete example.

---
 README.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/README.md b/README.md
index 6933f0f..9d96fb5 100644
--- a/README.md
+++ b/README.md
@@ -90,6 +90,10 @@ async fn register() -> Result<Mastodon> {
 
 It also supports the [Streaming API](https://docs.joinmastodon.org/api/streaming):
 
+> **Note**: this example compiles, but will not run. See the
+> [log_events](https://github.com/dscottboggs/mastodon-async/blob/main/examples/log_events.rs)
+> example for a more thorough example which does compile and run.
+
 ```rust,no_run
 use mastodon_async::{prelude::*, Result, entities::event::Event};
 use futures_util::TryStreamExt;
@@ -113,3 +117,4 @@ async fn main() -> Result<()> {
     Ok(())
 }
 ```
+