Skip to content

Commit

Permalink
docs: update custom bubbles requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
bashbunni committed Mar 13, 2024
1 parent e726cbf commit 4641735
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,8 +223,14 @@ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
list that is scrollable without pagination and has the ability to contain
other bubbles as list items.

If you’ve built a Bubble you think should be listed here,
[let us know](mailto:vt100@charm.sh).
If you’ve built a Bubble you think should be listed here, please create a Pull
Request. Please note that for a project to be included, it must meet the
following requirements:
- The README has a demo GIF.
- The README clearly states the purpose of the bubble along with an example on how to use it.
- The bubble must *always* be in a working state on its `main` branch.

Thank you!

## Feedback

Expand Down

0 comments on commit 4641735

Please sign in to comment.