Skip to content

Commit

Permalink
docs: add context to example
Browse files Browse the repository at this point in the history
  • Loading branch information
bashbunni committed Apr 8, 2022
1 parent 31a0721 commit b7c663c
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions 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)
Expand Down

0 comments on commit b7c663c

Please sign in to comment.