Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ArthurData committed Jan 16, 2025
1 parent 2f6a125 commit 8eb258d
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 3 deletions.
21 changes: 20 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,26 @@ Every time you run `golem::run_dev()`, the `signature.scss` file is compiled int

The redirection banner is a JavaScript function that redirects the user to the specified URL.

To modify the redirection URL, edit the `index.html` file at the root of the project.
To modify the redirection URL, creeate a `index.html` file at the root of the project.

See : [signature](https://github.com/ThinkR-open/signature/)

## Deployment

This application is deployed on Connect.

But also serverless directly with ShinyLive :

```{r eval=FALSE}
shinylive::export(".", "site")
httpuv::runStaticServer("site/")
```

or with Github Actions. [More details here](https://posit-dev.github.io/r-shinylive/#github-pages) :

```{r eval=FALSE}
usethis::use_github_action(url = "https://github.com/posit-dev/r-shinylive/blob/actions-v1/examples/deploy-app.yaml")
```

## You love this project?

Expand Down
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,28 @@ compiled into `inst/app/www/signature.css`.
The redirection banner is a JavaScript function that redirects the user
to the specified URL.

To modify the redirection URL, edit the `index.html` file at the root of
the project.
To modify the redirection URL, creeate a `index.html` file at the root
of the project.

See : [signature](https://github.com/ThinkR-open/signature/)

## Deployment

This application is deployed on Connect.

But also serverless directly with ShinyLive :

``` r
shinylive::export(".", "site")
httpuv::runStaticServer("site/")
```

or with Github Actions. [More details
here](https://posit-dev.github.io/r-shinylive/#github-pages) :

``` r
usethis::use_github_action(url = "https://github.com/posit-dev/r-shinylive/blob/actions-v1/examples/deploy-app.yaml")
```

## You love this project?

Expand Down

0 comments on commit 8eb258d

Please sign in to comment.