From 81fb44bae2278371a46546279a3598ad0a487d8a Mon Sep 17 00:00:00 2001
From: Samuel Calderon <samuel.calderon@uarm.pe>
Date: Wed, 13 Dec 2023 16:32:47 -0500
Subject: [PATCH] complete "First release" section of #1

---
 NEWS.md          | 2 +-
 R/SSEParser.R    | 2 ++
 README.Rmd       | 8 +++++++-
 cran-comments.md | 4 +++-
 man/SSEparser.Rd | 3 +++
 5 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/NEWS.md b/NEWS.md
index f874af1..e4eb2bc 100644
--- 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
index 59a2ad2..d6158f5 100644
--- 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
index 8220ecd..4d43db1 100644
--- 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
index 858617d..d13e8ea 100644
--- 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
index 3346310..926d063 100644
--- a/man/SSEparser.Rd
+++ b/man/SSEparser.Rd
@@ -3,6 +3,9 @@
 \name{SSEparser}
 \alias{SSEparser}
 \title{Parse a Server Sent Event}
+\value{
+An object with R6 class \code{SSEparser}
+}
 \description{
 This class can help you parse a single server sent event or a stream of them.
 You can inherit the class for a custom application.