Ux updates

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: box.lsp
 Title: Provides box-compatibility for languageserver
-Version: 0.0.0.9005
+Version: 0.0.0.9006
 Authors@R: 
   c(
     person("Ricardo Rodrigo", "Basa", role = c("aut", "cre"), email = "[email protected]"),

NEWS.md

@@ -1,3 +1,7 @@
+# box.lsp 0.0.0.9006
+
+* quality of life chores
+
 # box.lsp 0.0.0.9005
 
 * adds support for modules

R/utils.R

@@ -17,7 +17,10 @@ use_box_lsp <- function(file_path = ".Rprofile") {
     }
     write(to_write, file = file_path, append = TRUE)
     cli::cli_alert_success(
-      "{{box.lsp}} configuration written to {file_path}. Please check the changes made."
+      c(
+        "{{box.lsp}} configuration written to {file_path}. Please check the changes made. ",
+        "A restart of your editor may be necessary for the changes to take effect."
+      )
     )
   }, error = function(e) {
     cli::cli_abort(e)

README.md

@@ -20,6 +20,8 @@ The code is based on initial work by [Pavel Demin](https://github.com/Gotfrid).
 | `pkg[alias = fun]`        | ✓ | ✓ | ✓ | 0.0.0.9005 | No documentation |
 | `prefix/mod[alias = fun]` | ✓ | ✓ | ✓ | 0.0.0.9005 | No documentation |
 
+![](./man/figures/box.lsp_in_action.gif)
+
 ## How to use
 
 1. `box.lsp::use_box_lsp()` to configure your project's `.Rprofile` file.