docs(readme): update for v2 (#888)

Co-authored-by: Christian Rocha <christian@rocha.is>
This commit is contained in:
Ayman Bagabas
2026-02-23 18:00:24 -05:00
committed by GitHub
co-authored by Christian Rocha
parent af98365cc6
commit c81d525337
+14 -11
View File
@@ -1,8 +1,6 @@
# Bubbles
<p>
<img src="https://stuff.charm.sh/bubbles/bubbles-github.png" width="233" alt="The Bubbles Logo">
</p>
<img src="https://github.com/user-attachments/assets/a38a1cbc-b2e4-4a92-bfad-0090f0c1b48d" width="350" />
[![Latest Release](https://img.shields.io/github/release/charmbracelet/bubbles.svg)](https://github.com/charmbracelet/bubbles/releases)
[![GoDoc](https://godoc.org/github.com/golang/gddo?status.svg)](https://pkg.go.dev/github.com/charmbracelet/bubbles)
@@ -10,9 +8,14 @@
[![Go ReportCard](https://goreportcard.com/badge/charmbracelet/bubbles)](https://goreportcard.com/report/charmbracelet/bubbles)
Some components for [Bubble Tea](https://github.com/charmbracelet/bubbletea)
applications. These components are used in production in [Glow][glow], and [many other applications][otherstuff].
applications. These components are used in production in [Crush][crush], and [many other applications][otherstuff].
[glow]: https://github.com/charmbracelet/glow
> [!TIP]
>
> Upgrading from v1? Check out the [upgrade guide](./UPGRADE_GUIDE_V2.md), or
> point your LLM at it and let it go to town.
[crush]: https://github.com/charmbracelet/crush
[otherstuff]: https://github.com/charmbracelet/bubbletea/#bubble-tea-in-the-wild
## Spinner
@@ -188,11 +191,11 @@ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
## Theres more where that came from
To check out community-maintained Bubbles see [Charm &
Friends](https://github.com/charm-and-friends/additional-bubbles). Made a cool Bubble
that you want to share?
[PRs](https://github.com/charm-and-friends/additional-bubbles?tab=readme-ov-file#what-is-a-complete-project)
are welcome!
To check out community-maintained Bubbles see [Charm & Friends][charmandfriends].
Made a cool Bubble that you want to share? [PRs][prs] are welcome!
[charmandfriends]:
[prs]: https://github.com/charm-and-friends/additional-bubbles?tab=readme-ov-file#what-is-a-complete-project
## Contributing
@@ -214,7 +217,7 @@ Wed love to hear your thoughts on this project. Feel free to drop us a note!
---
Part of [Charm](https://charm.sh).
Part of [Charm](https://charm.land).
<a href="https://charm.sh/"><img alt="The Charm logo" src="https://stuff.charm.sh/charm-banner-next.jpg" width="400"></a>