updated readme and vignette

NEWS.md

@@ -1,4 +1,4 @@
-# shinybusy (unreleased)
+# shinybusy 0.3.0
 
 * Internal: use [{packer}](https://github.com/JohnCoene/packer) to manage JavaScript assets.
 * New function `update_modal_spinner()` to update modal spinner text ([#19](https://github.com/dreamRs/shinybusy/issues/19)).

README.md

@@ -30,8 +30,9 @@ remotes::install_github("dreamRs/shinybusy")
 
 ## Examples
 
+### Automated busy indicators
 
-### Gif
+#### Gif
 
 Animate a Gif when server is busy and pause animation when server is idle :
 
@@ -43,7 +44,7 @@ add_busy_gif(src = "https://jeroen.github.io/images/banana.gif", height = 70, wi
 
 
 
-### Progress bar
+#### Progress bar
 
 Make an infinite progress bar appear on top of the page when server is busy :
 
@@ -56,26 +57,21 @@ add_busy_bar(color = "#FF0000")
 
 
 
-### Spinner
+#### Spinner
 
 Add a spinner when server is busy on top-right corner of the page with:
 
-
 ```r
-# UI
 add_busy_spinner(spin = "fading-circle")
 ```
 
-Classic Shiny:
 ![](man/figures/shinybusy-spin.gif)
 
 
-Shinydashboard:
-![](man/figures/spin-dash.png)
 
-Shinythemes:
-![](man/figures/spin-theme.png)
+### Other functionalities
 
+Display a loading indicator at the start of the application until it is ready to be used, block application interaction until a calculation is done, send notifications to user, ... See vignette or [online website](https://dreamrs.github.io/shinybusy/) for more.
 
 
 

vignettes/shinybusy-usage.Rmd → vignettes/shinybusy.Rmd

@@ -161,3 +161,20 @@ Don't forget to remove the modal window when computation is finished !
 
 
 
+## Notifications
+
+Show notifications and reports to user through JavaScript library [Notiflix](https://notiflix.github.io/). Four appearance are available: success, failure, info and warning. Notifications are fully configurable.
+
+```{r notifications, eval=FALSE}
+# success notification
+notify_success("Well done!")
+
+# report failure
+report_failure(
+  "Oups...",
+  "Something went wrong"
+)
+```
+
+
+