diff --git a/examples/download-progress/README.md b/examples/progress-download/README.md similarity index 58% rename from examples/download-progress/README.md rename to examples/progress-download/README.md index 730860ff35..7d95c548f8 100644 --- a/examples/download-progress/README.md +++ b/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 b/examples/progress-download/main.go similarity index 100% rename from examples/download-progress/main.go rename to examples/progress-download/main.go diff --git a/examples/download-progress/tui.go b/examples/progress-download/tui.go similarity index 100% rename from examples/download-progress/tui.go rename to examples/progress-download/tui.go