0.1.1 docs 🚀

hypebright · Mar 4, 2024 · 98841c0 · 98841c0
1 parent 9e55a61
commit 98841c0
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 1 deletion.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: fireworks
 Title: Fireworks for your 'Shiny' application
-Version: 0.1.0
+Version: 0.1.1
 Authors@R: 
     person("Veerle", "van Leemput", , "[email protected]", role = c("aut", "cre"))
 Description: 'fireworks' is a wrapper around the 'fireworks-js' library that contains

diff --git a/NEWS.md b/NEWS.md
@@ -0,0 +1,4 @@
+# fireworks 0.1.1
+
+* Added a `fadeOut` argument to the `stop` method to control whether the fireworks fade out or disappear instantly. The effects lasts 2000 ms to remove the fireworks in a natural manner. Thanks to @laresbernardo for the suggestion in issue #1. Example can be found in `inst/examples/02-fireworks-on-demand.R`.
+* Added a `NEWS.md` file to track changes to the package.
diff --git a/README.md b/README.md
@@ -132,6 +132,18 @@ fw <- Fireworks$new(options = list(hue = list(min = 0, max = 45),
                                    traceSpeed = 5))
 ```
 
+### Natural stop effect
+
+By default, fireworks are removed immediately when `stop` is called. You can add a natural stop effect by setting `fadeOut = TRUE`:
+
+```r
+fw$stop(fadeOut = TRUE)
+```
+
+The effects takes 2000ms and looks changes the intensity of the fireworks down to 1:
+
+![](./inst/images/fireworks-fadeout.gif)
+
 ## Acknowledgements
 
 As this is a wrapper around an existing library, I want to give credit to the original authors:

diff --git a/inst/images/fireworks-fadeout.gif b/inst/images/fireworks-fadeout.gif