Skip to content

Commit 089b4db

Browse files
authored
docs: update custom bubbles requirements (charmbracelet#495)
1 parent e521fea commit 089b4db

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

+8-2
Original file line numberDiff line numberDiff line change
@@ -223,8 +223,14 @@ func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
223223
list that is scrollable without pagination and has the ability to contain
224224
other bubbles as list items.
225225

226-
If you’ve built a Bubble you think should be listed here,
227-
[let us know](mailto:[email protected]).
226+
If you’ve built a Bubble you think should be listed here, please create a Pull
227+
Request. Please note that for a project to be included, it must meet the
228+
following requirements:
229+
- The README has a demo GIF.
230+
- The README clearly states the purpose of the bubble along with an example on how to use it.
231+
- The bubble must *always* be in a working state on its `main` branch.
232+
233+
Thank you!
228234

229235
## Feedback
230236

0 commit comments

Comments
 (0)