Skip to content

Commit 13d1648

Browse files
committed
get ready for CRAN submission
1 parent 114e4e0 commit 13d1648

File tree

3 files changed

+10
-9
lines changed

3 files changed

+10
-9
lines changed

DESCRIPTION

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: shinybrowser
2-
Title: Find Out Information About a User's Web Browser in 'Shiny' 🌐
3-
Version: 0.0.0.9001
2+
Title: Find Out Information About a User's Web Browser in 'Shiny'
3+
Version: 1.0.0
44
Authors@R: person("Dean", "Attali",
55
email = "daattali@gmail.com",
66
role = c("aut", "cre"),
@@ -18,7 +18,6 @@ Imports:
1818
Suggests:
1919
shinydisconnect
2020
License: MIT + file LICENSE
21-
LazyData: true
2221
Encoding: UTF-8
23-
RoxygenNote: 7.1.1
22+
RoxygenNote: 7.1.2
2423
Roxygen: list(markdown = TRUE)

NEWS.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
# Unreleased version
1+
# shinybrowser 1.0.0 (2022-05-11)
2+
3+
Initial CRAN release

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ The available information is: browser name (such as "Chrome" or "Safari") and ve
7373

7474
When building a Shiny app for other users, sometimes you might want to know some information about the user's browser and system. A few scenarios where this can be useful:
7575

76-
1. Your Shiny app is using an advanced browser functionality that isn't supported in Internet Explorer. If a user views your app on Internet Explorer, you want to show them a warning message that some functionality might not work.
77-
2. Your app shows some text to the user and you want to show them a message with the keyboard shortcut for copying the text to their clipboard. You need to know whether the user is on Windows or Mac to decide what keyboard shortcut to use (ctrl+C vs command+C).
76+
1. Your Shiny app is using an advanced browser functionality that isn't supported in Internet Explorer. If a user views your app on Internet Explorer, you want to show them a warning message.
77+
2. Your app displays some text to the user and you want to show them a message with the keyboard shortcut for copying the text to their clipboard. You need to know whether the user is on Windows or Mac to decide what keyboard shortcut to use (ctrl+C vs command+C).
7878
3. Your app contains a plot with a legend. If the user is on a wide enough screen, you want the legend to appear beside the plot, but if the screen is too narrow then you want the legend to appear below the plot.
7979

8080
In these situations, you want to detect information about the user's browser type (scenario 1), operating system (scenario 2), or browser dimensions (scenario 3).
@@ -92,9 +92,9 @@ Developing and maintaining many packages takes a lot of time. Please consider sp
9292

9393
<h2 id="usage">How to use</h2>
9494

95-
First you need to call `detect()` anywhere in the UI. This will initialize {shinybrowser} and run the script that attempts to detect all the user information and send it to Shiny.
95+
First you need to call `detect()` anywhere in the UI. This will initialize {shinybrowser}, run the script that attempts to detect all the user information, and send it to Shiny.
9696

97-
Then you can use any of the {shinybrowser} functions to inquire about the user. You can use and `get_browser()`/`get_browser_version()` to get the browser name and version, `get_os()`/`get_os_version()` to get the operating system, `get_device()` to find out if the user is on mobile or desktop, and `get_width()`/`get_height()` to find out the browser dimensions.
97+
Then you can use any of the {shinybrowser} functions to inquire about the user. You can use `get_browser()`/`get_browser_version()` to get the browser name and version, `get_os()`/`get_os_version()` to get the operating system, `get_device()` to find out if the user is on mobile or desktop, and `get_width()`/`get_height()` to find out the browser dimensions.
9898

9999
All these values are reactive, so they must be accessed inside an `observe()`/`reactive()` or similar.
100100

0 commit comments

Comments
 (0)