Skip to content

Commit 03623c3

Browse files
committed
Clarify peeky intent
1 parent e5a8428 commit 03623c3

File tree

2 files changed

+29
-23
lines changed

2 files changed

+29
-23
lines changed

README.Rmd

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,21 @@ knitr::opts_chunk$set(
1919
[![R-CMD-check](https://github.com/coatless-rpkg/peeky/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/coatless-rpkg/peeky/actions/workflows/R-CMD-check.yaml)
2020
<!-- badges: end -->
2121

22-
The `peeky` package is a tool for examining and extracting files from standalone
23-
[Shinylive applications][slexplain] and [Quarto][quarto] documents that contain Shinylive components
24-
through the [`quarto-shinylive`][qsl] extension.
25-
This package works for both R and Python Shinylive applications.
22+
The `peeky` package helps you extract, examine, and run the source code from Shiny
23+
applications that have been converted to run in the browser using [Shinylive][slexplain].
24+
It works with both standalone converted applications and [Quarto][quarto] documents
25+
containing converted Shiny components through the [quarto-shinylive][qsl] extension.
26+
This package supports both R and Python Shiny applications that have been
27+
converted to Shinylive.
2628

2729
## What is Shinylive?
2830

29-
Shinylive is groundbreaking technology that converts existing Shiny applications
30-
to run entirely in the web browser using WebAssembly, eliminating the need for a
31+
[Shinylive][slexplain] is groundbreaking technology that converts existing Shiny applications
32+
to run entirely in the web browser using [WebAssembly][wasm], eliminating the need for a
3133
hosted server. At its core, a Shinylive app is simply a converted
3234
Shiny application - the same application you'd normally run on a server, but
33-
transformed to execute directly in the browser through [webR][webr] for R applications
34-
or [Pyodide][pyodide] for Python applications.
35+
transformed to execute directly in the user's browser through [webR][webr] for
36+
R applications or [Pyodide][pyodide] for Python applications.
3537

3638
The Shinylive ecosystem consists of four main components:
3739

@@ -163,3 +165,4 @@ tools like Shinylive possible.
163165
[webr]: https://docs.r-wasm.org/webr/latest/
164166
[pyodide]: https://pyodide.org/en/stable/
165167
[peeksl]: https://github.com/coatless-tutorials/peeking-at-an-r-shinylive-app-source-code
168+
[wasm]: https://webassembly.org/

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,27 @@
88
[![R-CMD-check](https://github.com/coatless-rpkg/peeky/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/coatless-rpkg/peeky/actions/workflows/R-CMD-check.yaml)
99
<!-- badges: end -->
1010

11-
The `peeky` package is a tool for examining and extracting files from
12-
standalone [Shinylive
13-
applications](https://shiny.posit.co/py/docs/shinylive.html) and
14-
[Quarto](https://quarto.org) documents that contain Shinylive components
15-
through the
16-
[`quarto-shinylive`](https://github.com/quarto-ext/shinylive) extension.
17-
This package works for both R and Python Shinylive applications.
11+
The `peeky` package helps you extract, examine, and run the source code
12+
from Shiny applications that have been converted to run in the browser
13+
using [Shinylive](https://shiny.posit.co/py/docs/shinylive.html). It
14+
works with both standalone converted applications and
15+
[Quarto](https://quarto.org) documents containing converted Shiny
16+
components through the
17+
[quarto-shinylive](https://github.com/quarto-ext/shinylive) extension.
18+
This package supports both R and Python Shiny applications that have
19+
been converted to Shinylive.
1820

1921
## What is Shinylive?
2022

21-
Shinylive is groundbreaking technology that converts existing Shiny
22-
applications to run entirely in the web browser using WebAssembly,
23-
eliminating the need for a hosted server. At its core, a Shinylive app
24-
is simply a converted Shiny application - the same application you’d
25-
normally run on a server, but transformed to execute directly in the
26-
browser through [webR](https://docs.r-wasm.org/webr/latest/) for R
27-
applications or [Pyodide](https://pyodide.org/en/stable/) for Python
28-
applications.
23+
[Shinylive](https://shiny.posit.co/py/docs/shinylive.html) is
24+
groundbreaking technology that converts existing Shiny applications to
25+
run entirely in the web browser using
26+
[WebAssembly](https://webassembly.org/), eliminating the need for a
27+
hosted server. At its core, a Shinylive app is simply a converted Shiny
28+
application - the same application you’d normally run on a server, but
29+
transformed to execute directly in the user’s browser through
30+
[webR](https://docs.r-wasm.org/webr/latest/) for R applications or
31+
[Pyodide](https://pyodide.org/en/stable/) for Python applications.
2932

3033
The Shinylive ecosystem consists of four main components:
3134

0 commit comments

Comments
 (0)