Skip to content

Commit 268a73f

Browse files
committed
More tweaks
1 parent 527b5af commit 268a73f

File tree

2 files changed

+17
-12
lines changed

2 files changed

+17
-12
lines changed

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
>
77
> This package is currently in the prototype/experimental stage. It is
88
> not yet available on CRAN and may have bugs or limitations.
9+
>
10+
> **We do not recommend using this package for production applications
11+
> at this time.**
912
1013
# shinyelectron
1114

@@ -90,9 +93,9 @@ You can customize the export process using the following options:
9093
``` r
9194
shinyelectron::export(
9295
appdir = "path/to/your/shiny/app",
93-
destdir = ""path/to/export/destination",
96+
destdir = "path/to/export/destination",
9497
app_name = "My-App-Title", # Defaults to the name of the appdir
95-
app_type = "r-shinylive", # We only support "r-shinylive" currently
98+
app_type = "r-shinylive", # We only support "r-shinylive"
9699
platform = c("mac"), # c("win", "mac", "linux")
97100
arch = c("arm64"), # c("x64", "arm64")
98101
overwrite = TRUE, # Overwrite existing files in destdir
@@ -137,14 +140,14 @@ applications with the Electron framework.
137140

138141
### Talks, Tutorials, and Templates:
139142

140-
- **User! 2018 Talk**: A presentation by @ksasso at the 2018 UseR!
141-
conference that demonstrates how to convert Shiny apps into standalone
142-
desktop applications using Electron.
143-
[ksassouser2018talk](https://www.youtube.com/watch?v=ARrbbviGvjc)
143+
- **User! 2018 Talk**: A [presentation by @ksasso at the 2018 UseR!
144+
conference](https://www.youtube.com/watch?v=ARrbbviGvjc) that
145+
demonstrates how to convert Shiny apps into standalone desktop
146+
applications using Electron.
144147
- **Developer Tutorials**: Valuable step-by-step guides from
145148
contributors like @lawalter and @dirkschumacher that demonstrate
146-
practical integration techniques and
147-
solutions.[shiny-electron-walter-tutorial](https://github.com/dirkschumacher/r-shiny-electron)
149+
practical integration techniques and solutions, c.f.
150+
[shiny-electron-walter-tutorial](https://github.com/dirkschumacher/r-shiny-electron)
148151
- **Zarathu Corporation Templates**: Specialized templates for [macOS
149152
ARM
150153
(M1/M2/..)](https://github.com/zarathucorp/shiny-electron-template-m1)

README.qmd

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ knitr::opts_chunk$set(
1717
:::{.callout-important}
1818
This package is currently in the prototype/experimental stage. It is not yet
1919
available on CRAN and may have bugs or limitations.
20+
21+
**We do not recommend using this package for production applications at this time.**
2022
:::
2123

2224
# shinyelectron
@@ -97,9 +99,9 @@ You can customize the export process using the following options:
9799
```r
98100
shinyelectron::export(
99101
appdir = "path/to/your/shiny/app",
100-
destdir = ""path/to/export/destination",
102+
destdir = "path/to/export/destination",
101103
app_name = "My-App-Title", # Defaults to the name of the appdir
102-
app_type = "r-shinylive", # We only support "r-shinylive" currently
104+
app_type = "r-shinylive", # We only support "r-shinylive"
103105
platform = c("mac"), # c("win", "mac", "linux")
104106
arch = c("arm64"), # c("x64", "arm64")
105107
overwrite = TRUE, # Overwrite existing files in destdir
@@ -133,8 +135,8 @@ applications with the Electron framework.
133135

134136
### Talks, Tutorials, and Templates:
135137

136-
- **User! 2018 Talk**: A presentation by @ksasso at the 2018 UseR! conference that demonstrates how to convert Shiny apps into standalone desktop applications using Electron. [ksassouser2018talk]
137-
- **Developer Tutorials**: Valuable step-by-step guides from contributors like @lawalter and @dirkschumacher that demonstrate practical integration techniques and solutions.[shiny-electron-walter-tutorial][shiny-electron-dirk-tutorial]
138+
- **User! 2018 Talk**: A [presentation by @ksasso at the 2018 UseR! conference][ksassouser2018talk] that demonstrates how to convert Shiny apps into standalone desktop applications using Electron.
139+
- **Developer Tutorials**: Valuable step-by-step guides from contributors like @lawalter and @dirkschumacher that demonstrate practical integration techniques and solutions, c.f. [shiny-electron-walter-tutorial][shiny-electron-dirk-tutorial]
138140
- **Zarathu Corporation Templates**: Specialized templates for [macOS ARM (M1/M2/..)][shiny-electron-zarathucorp-m1] and [Windows][shiny-electron-zarathucorp-windows] platforms that have significantly contributed to cross-platform deployment solutions
139141
described in [R-Bloggers: Creating Standalone Apps from Shiny with Electron][shiny-electron-zarathucorp-rbloggers] post.
140142

0 commit comments

Comments
 (0)