docs: add instructions to run download-progress

charmbracelet · May 6, 2022 · 55d9d23 · 55d9d23
1 parent 6b28a31
commit 55d9d23
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/examples/download-progress/README.md b/examples/download-progress/README.md
@@ -0,0 +1,8 @@
+# Download Progress
+This example was built based on [this](https://github.com/charmbracelet/bubbles/discussions/127) discussion.
+
+## How to Run
+`go build .` in this directory on your machine (in examples/download-progress)
+then run `./download-progress --url="https://download.blender.org/demo/color_vortex.blend"` this can be whatever file you'd like to download. 
+Note: the current version will not show a TUI for downloads that do not provide the ContentLength header field.
+