docs: add context to example

charmbracelet · Apr 8, 2022 · 1d398e1 · 1d398e1
1 parent 31a0721
commit 1d398e1
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/examples/download-progress/README.md b/examples/download-progress/README.md
@@ -1,5 +1,7 @@
 # Download Progress
 This example was built based on [this](https://github.com/charmbracelet/bubbles/discussions/127) discussion.
+This example demonstrates how to download a file from a given URL, and show its progress with a [progress Bubble](https://github.com/charmbracelet/bubbles/).
+The status of the download is updated with `io.TeeReader`. This calls `Write` which is where we send the updated status with `p.Send` 
 
 ## How to Run
 `go build .` in this directory on your machine (in examples/download-progress)