From b7c663cbfcb8a98bddce0675b350e9203aa7a773 Mon Sep 17 00:00:00 2001 From: bashbunni Date: Fri, 8 Apr 2022 14:10:02 -0700 Subject: [PATCH] docs: add context to example --- examples/download-progress/README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/examples/download-progress/README.md b/examples/download-progress/README.md index 730860ff35..7d95c548f8 100644 --- a/examples/download-progress/README.md +++ b/examples/download-progress/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)