From f27cfbde8775e0ce850c81f7eb6ba481622e5c3e Mon Sep 17 00:00:00 2001
From: Tessa Kelly <tessakkelly@gmail.com>
Date: Fri, 15 May 2020 11:00:18 -0700
Subject: [PATCH] Adds documentation for burst

---
 src/Nri/Ui/Confetti/V1.elm | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/src/Nri/Ui/Confetti/V1.elm b/src/Nri/Ui/Confetti/V1.elm
index 54e70848..45965f14 100644
--- a/src/Nri/Ui/Confetti/V1.elm
+++ b/src/Nri/Ui/Confetti/V1.elm
@@ -139,7 +139,17 @@ viewConfetti particle =
 -- UPDATE
 
 
-{-| -}
+{-| `burst` BURSTS CONFETTI!!! Pass in a list of words that you'd like to have
+in the confetti:
+
+    Confetti.burst
+        [ { color = Colors.highlightMagenta, text = "tree" }
+        , { color = Colors.highlightGreen, text = "bush" }
+        , { color = Colors.highlightCyan, text = "succulent" }
+        ]
+        state.confetti
+
+-}
 burst : List { color : Color, text : String } -> Model -> Model
 burst highlightedWords (System system center) =
     System