Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jcpsantiago committed Jul 14, 2024
1 parent 5247117 commit a24b49d
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can install the latest development version of `sentryR` with:

``` r
# install.packages("remotes")
remotes::install_github("ozean12/sentryR")
remotes::install_github("jcpsantiago/sentryR")
```

or the stable version in CRAN with:
Expand All @@ -28,8 +28,8 @@ install.packages("sentryR")
`configure_sentry` and `capture` are the two core functions of `sentryR`.
The first sets up an isolated environment with your Sentry project's DSN,
optionally your app's name, version and the environment it's running in.
Both `configure_sentry` and any of the `capture_` functions accept
additional fields to pass on to Sentry as named lists.
Both `configure_sentry` and any of the `capture_` functions accept
additional fields to pass on to Sentry as named lists.
`NULL`ifying a field will remove it.

```r
Expand Down Expand Up @@ -82,7 +82,7 @@ list(

## Example with Plumber

In a Plumber API, besides the initial configuration for Sentry,
In a Plumber API, besides the initial configuration for Sentry,
you'll also have to set the error handler.

`sentryR` ships with the default `plumber` error handler wrapped
Expand All @@ -103,7 +103,7 @@ versions <- installed_pkgs_df$Version
names(versions) <- installed_pkgs_df$Package
packages <- as.list(versions)

configure_sentry(dsn = Sys.getenv('SENTRY_DSN'),
configure_sentry(dsn = Sys.getenv('SENTRY_DSN'),
app_name = "myapp", app_version = "1.0.0",
modules = packages)

Expand Down Expand Up @@ -136,7 +136,7 @@ by providing a callback function to the `shiny.error` option.
library(shiny)
library(sentryR)

configure_sentry(dsn = Sys.getenv('SENTRY_DSN'),
configure_sentry(dsn = Sys.getenv('SENTRY_DSN'),
app_name = "myapp", app_version = "1.0.0",
modules = packages)

Expand All @@ -152,11 +152,6 @@ shinyServer(function(input, output) {
}
```

## TODO
* test the error handling functions, needs mocking?
* posting to sentry asynchronously
* vignettes

## Acknowledgements

`sentryR` took inspiration from
Expand Down

0 comments on commit a24b49d

Please sign in to comment.