docs: add context to example

charmbracelet · May 6, 2022 · 2613b70 · 2613b70
1 parent 9293642
commit 2613b70
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/examples/download-progress/README.md → examples/progress-download/README.md b/examples/download-progress/README.md → examples/progress-download/README.md
@@ -1,5 +1,8 @@
 # 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`](https://pkg.go.dev/io#TeeReader).
+This calls `Write` which is where we send the updated status with `Program#Send()` 
 
 ## How to Run
 `go build .` in this directory on your machine (in examples/download-progress)

diff --git a/examples/download-progress/main.go → examples/progress-download/main.go b/examples/download-progress/main.go → examples/progress-download/main.go
diff --git a/examples/download-progress/tui.go → examples/progress-download/tui.go b/examples/download-progress/tui.go → examples/progress-download/tui.go