From 2b22d5293f2d44b1d5892386b8ea70220c8c64ea Mon Sep 17 00:00:00 2001 From: bashbunni <15822994+bashbunni@users.noreply.github.com> Date: Wed, 13 Mar 2024 13:21:30 -0700 Subject: [PATCH] docs: update custom bubbles requirements (#495) --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2e9916d..80eb2aa 100644 --- a/README.md +++ b/README.md @@ -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