Add bubbletea workaround to README.md

erikgeiser · Sep 8, 2021 · 7cfe845 · 7cfe845
1 parent f6f0fea
commit 7cfe845
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -18,7 +18,14 @@ and many opportunities for heavy customization.
 
 ---
 
-**Warning:** The API of library is not yet stable. Expect significant changes before 1.0.0.
+**Warning:** This library depends on some significant [upsteam changes in bubbletea](https://github.com/charmbracelet/bubbletea/pull/120). Until they are merged you can use the following workaround in your project:
+
+```
+go mod edit -replace=github.com/charmbracelet/bubbletea=github.com/erikgeiser/bubbletea@cleanup_after_termination
+go mod tidy
+```
+
+**Disclaimer:** The API of library is not yet stable. Expect significant changes before 1.0.0.
 
 ---