Update pkgdown documentation

r-wasm · Aug 7, 2024 · a0e7be0 · a0e7be0
1 parent 0eb79ea
commit a0e7be0
Show file tree

Hide file tree

Showing 10 changed files with 6 additions and 0 deletions.
diff --git a/pkgdown/favicon/apple-touch-icon-120x120.png b/pkgdown/favicon/apple-touch-icon-120x120.png
diff --git a/pkgdown/favicon/apple-touch-icon-152x152.png b/pkgdown/favicon/apple-touch-icon-152x152.png
diff --git a/pkgdown/favicon/apple-touch-icon-180x180.png b/pkgdown/favicon/apple-touch-icon-180x180.png
diff --git a/pkgdown/favicon/apple-touch-icon-60x60.png b/pkgdown/favicon/apple-touch-icon-60x60.png
diff --git a/pkgdown/favicon/apple-touch-icon-76x76.png b/pkgdown/favicon/apple-touch-icon-76x76.png
diff --git a/pkgdown/favicon/apple-touch-icon.png b/pkgdown/favicon/apple-touch-icon.png
diff --git a/pkgdown/favicon/favicon-16x16.png b/pkgdown/favicon/favicon-16x16.png
diff --git a/pkgdown/favicon/favicon-32x32.png b/pkgdown/favicon/favicon-32x32.png
diff --git a/pkgdown/favicon/favicon.ico b/pkgdown/favicon/favicon.ico
diff --git a/vignettes/mount-fs-image.Rmd b/vignettes/mount-fs-image.Rmd
@@ -39,6 +39,12 @@ rwasm::file_packager("./some/data/directory", out_name = "output_image.data")
 
 Again, this function writes output filesystem images to the `vfs` directory by default.
 
+### Compression
+
+The `add_pkg()`, `make_vfs_library()`, `file_packager()` and other related functions support the `compression` argument. The default value is `FALSE`, but when `TRUE` VFS images will be `gzip` compressed for deployment. For some types of package content, the savings in file size with compression can be significant.
+
+**NOTE**: Loading compressed VFS images requires at least version 0.4.1 of webR.
+
 ## Mounting filesystem images
 
 The filesystem image(s) should now be hosted by a web server so that it is available at some URL. Such a URL can then be passed to `webr::mount()` to be made available on the virtual filesystem for the Wasm R process.