prepare for release

.Rbuildignore

@@ -7,3 +7,4 @@
 ^docs$
 ^pkgdown$
 ^vignettes/articles$
+^cran-comments\.md$

DESCRIPTION

@@ -1,13 +1,9 @@
 Package: lzstring
 Type: Package
-Title: An R wrapper of lzstring C++ library
+Title: Wrapper for 'lz-string' C++ Library
 Version: 0.1.0
-Author: Sam Parmar
-Maintainer: Sam Parmar <[email protected]>
-Description: R interface to the lz-string C++ library, enabling LZ-based 
-    compression and decompression of strings directly within R. Useful for
-    reducing the memory footprint of large strings or transmitting 
-    compressed data.
+Description: Provide access to  the 'lz-string' C++ library for LZ-based 
+    compression and decompression of strings.
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
@@ -16,13 +12,13 @@ LinkingTo:
 Suggests: 
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 URL: https://parmsam.github.io/lzstring-r/, https://github.com/parmsam/lzstring-r
 Authors@R: c(
     person(
         given = "Sam", 
         family = "Parmar",
-        role = c("aut", "cre")
+        role = c("aut", "cre"),
         email = "[email protected]"
     ),
     person(

R/lzstringr-package.R

@@ -82,9 +82,7 @@ safe_decompress <- function(string, f) {
 #' @return A character string representing the compressed input string in Base64 format.
 #' @export
 #' @examples
-#' \dontrun{
 #' compressToBase64("Hello, world!")
-#' }
 compressToBase64 <- function(string) {
   stopifnot(
     "`string` must be a character." = is.character(string),
@@ -101,9 +99,8 @@ compressToBase64 <- function(string) {
 #' @return A character string representing the decompressed input string.
 #' @export
 #' @examples
-#' \dontrun{
-#' decompressFromBase64(compressed_string)
-#' }
+#' x <- compressToBase64("Hello, world!")
+#' decompressFromBase64(x)
 decompressFromBase64 <- function(string) {
   stopifnot(
     "`string` must be a character." = is.character(string),
@@ -120,9 +117,7 @@ decompressFromBase64 <- function(string) {
 #' @return A character string representing the compressed input string in Encoded URI Component format.
 #' @export
 #' @examples
-#' \dontrun{
 #' compressToEncodedURIComponent("Hello, world!")
-#' }
 compressToEncodedURIComponent <- function(string) {
   stopifnot(
     "`string` must be a character." = is.character(string),
@@ -139,9 +134,8 @@ compressToEncodedURIComponent <- function(string) {
 #' @return A character string representing the decompressed input string.
 #' @export
 #' @examples
-#' \dontrun{
-#' decompressFromEncodedURIComponent(compressed_string)
-#' }
+#' x <- compressToEncodedURIComponent("Hello, world!")
+#' decompressFromEncodedURIComponent(x)
 decompressFromEncodedURIComponent <- function(string) {
   stopifnot(
     "`string` must be a character." = is.character(string),

README.Rmd

@@ -26,6 +26,12 @@ The goal of lzstring-r is to provide an R wrapper for the [lzstring C++ library]
 
 ## Installation
 
+You can install the released version of lzstringr from CRAN with:
+
+``` r
+install.packages("lzstringr")
+```
+
 You can install the development version of lzstringr from [GitHub](https://github.com/) with:
 
 ``` r

README.md

@@ -27,6 +27,12 @@ lzstring in JavaScript—peek at his work over
 
 ## Installation
 
+You can install the released version of lzstringr from CRAN with:
+
+``` r
+install.packages("lzstringr")
+```
+
 You can install the development version of lzstringr from
 [GitHub](https://github.com/) with:
 

cran-comments.md

@@ -0,0 +1,5 @@
+## R CMD check results
+
+0 errors | 0 warnings | 1 note
+
+* This is a new release.