complete "First release" section of #1

calderonsamuel · Dec 13, 2023 · 81fb44b · 81fb44b
1 parent 4b5bdd7
commit 81fb44b
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 3 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,4 +1,4 @@
 # SSEparser 0.0.0.9000
 
 - Added a `NEWS.md` file to track changes to the package.
-- Export the SSEparser class.
+- Export the SSEparser class, and the `parse_sse()` function as a higher level wrapper.
diff --git a/R/SSEParser.R b/R/SSEParser.R
@@ -42,6 +42,8 @@
 #' @importFrom stringr str_split str_starts str_detect str_split_1 str_trim
 #' @importFrom purrr pluck map discard reduce compact
 #' 
+#' @returns An object with R6 class `SSEparser`
+#' 
 #' @export
 #' 
 #' @examples

diff --git a/README.Rmd b/README.Rmd
@@ -26,7 +26,13 @@ The goal of SSEparser is to provide robust functionality to parse Server-Sent Ev
 
 ## Installation
 
-You can install the development version of SSEparser like so:
+You can install `SEEparser` from CRAN like so:
+
+```r
+install.packages("gptstudio")
+```
+
+Alternatively, you can install the development version like so:
 
 ``` r
 pak::pak("calderonsamuel/SSEparser")

diff --git a/cran-comments.md b/cran-comments.md
@@ -1,5 +1,7 @@
 ## R CMD check results
 
-0 errors | 0 warnings | 1 note
+0 errors | 0 warnings | 0 note
 
 * This is a new release.
+* There are no external references describing the methods in this package.
+* urlchecker::url_check() flags 'https://CRAN.R-project.org/package=SSEparser' as error. It will stop failing once the package, hopefully, is accepted. 
diff --git a/man/SSEparser.Rd b/man/SSEparser.Rd