Minor fixes & pkddown

.github/.gitignore

@@ -0,0 +1 @@
+*.html

.github/workflows/pkgdown.yaml

@@ -0,0 +1,45 @@
+on:
+  push:
+    branches: master
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: macOS-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-r@master
+
+      - uses: r-lib/actions/setup-pandoc@master
+
+      - name: Query dependencies
+        run: |
+          install.packages('remotes')
+          saveRDS(remotes::dev_package_deps(dependencies = TRUE), ".github/depends.Rds", version = 2)
+          writeLines(sprintf("R-%i.%i", getRversion()$major, getRversion()$minor), ".github/R-version")
+        shell: Rscript {0}
+
+      - name: Cache R packages
+        uses: actions/cache@v1
+        with:
+          path: ${{ env.R_LIBS_USER }}
+          key: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-${{ hashFiles('.github/depends.Rds') }}
+          restore-keys: ${{ runner.os }}-${{ hashFiles('.github/R-version') }}-1-
+
+      - name: Install dependencies
+        run: |
+          install.packages("remotes")
+          remotes::install_deps(dependencies = TRUE)
+          remotes::install_dev("pkgdown")
+        shell: Rscript {0}
+
+      - name: Install package
+        run: R CMD INSTALL .
+
+      - name: Deploy package
+        run: pkgdown::deploy_to_branch(new_process = FALSE)
+        shell: Rscript {0}

.gitignore

@@ -5,3 +5,4 @@
 .Rbuildignore
 *.webloc
 .httr-oauth
+docs

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: livecode
-Title: Broadcast a source file to multiple concurrant users
+Title: Broadcast a Source File to Multiple Concurrent Users
 Version: 0.1.0.9000
 Authors@R: 
     person(given = "Colin",
@@ -26,6 +26,8 @@ Imports:
     tibble,
     crayon,
     rstudioapi
-RoxygenNote: 7.1.0
+RoxygenNote: 7.1.1
 LinkingTo: 
     Rcpp
+URL: https://github.com/rundel/livecode
+BugReports: https://github.com/rundel/livecode/issues

NAMESPACE

@@ -12,4 +12,6 @@ export(network_interfaces)
 export(serve_file)
 export(stop_all)
 importFrom(Rcpp,sourceCpp)
+importFrom(stats,setNames)
+importFrom(utils,URLencode)
 useDynLib(livecode, .registration = TRUE)

R/file_stream_server.R

@@ -126,7 +126,7 @@ file_stream_server = function(host, port, file, file_id, interval = 3, template
     },
 
     staticPaths = list(
-      "/web" = livecode:::pkg_resource("resources")
+      "/web" = pkg_resource("resources")
     )
   )
 

R/livecode-package.R

@@ -0,0 +1,10 @@
+#' @keywords internal
+#' @importFrom stats setNames
+#' @importFrom utils URLencode
+"_PACKAGE"
+
+# The following block is used by usethis to automatically manage
+# roxygen namespace tags. Modify with care!
+## usethis namespace: start
+## usethis namespace: end
+NULL

README.Rmd

@@ -44,7 +44,7 @@ server$stop()
 
 ## Using bitly
 
-`livecode` has built in functionality for generating a bitlink automatically for your livecoding session. To do this you will need to provide `livecode` with a bitly API access token. To obtain one of these tokens you will need to create an account with bitly (the free tier is sufficient) and then select <kbd>Profile Settings</kbd> > <kbd>Generic Access Token</kbd> and then enter your password when prompted. This results in a long hexidecimal string that you should copy to your clipboard.
+`livecode` has built in functionality for generating a bitlink automatically for your livecoding session. To do this you will need to provide `livecode` with a bitly API access token. To obtain one of these tokens you will need to create an account with bitly (the free tier is sufficient) and then select <kbd>Profile Settings</kbd> > <kbd>Generic Access Token</kbd> and then enter your password when prompted. This results in a long hexadecimal string that you should copy to your clipboard.
 
 `livecode` looks for this token in an environmental variable called `BITLY_PAT`. To properly configure this environmental variable we can use the `usethis` package. In R run the following,
 
@@ -58,7 +58,7 @@ which will open your `.Renviron` file for you and you will just need to add a si
 BITLY_PAT=0123456789abcdef0123456789abcdef01234567
 ```
 
-replacing `0123456789abcdef0123456789abcdef01234567` with the hexidecimal string you copied from bitly. After saving `.Renviron` you will need to restart your R session and can then test that your token is function correctly by running,
+replacing `0123456789abcdef0123456789abcdef01234567` with the hexadecimal string you copied from bitly. After saving `.Renviron` you will need to restart your R session and can then test that your token is function correctly by running,
 
 ```r
 livecode::bitly_test_token()

README.md

@@ -52,7 +52,7 @@ provide `livecode` with a bitly API access token. To obtain one of these
 tokens you will need to create an account with bitly (the free tier is
 sufficient) and then select <kbd>Profile Settings</kbd> \> <kbd>Generic
 Access Token</kbd> and then enter your password when prompted. This
-results in a long hexidecimal string that you should copy to your
+results in a long hexadecimal string that you should copy to your
 clipboard.
 
 `livecode` looks for this token in an environmental variable called
@@ -69,7 +69,7 @@ add a single line with the format
     BITLY_PAT=0123456789abcdef0123456789abcdef01234567
 
 replacing `0123456789abcdef0123456789abcdef01234567` with the
-hexidecimal string you copied from bitly. After saving `.Renviron` you
+hexadecimal string you copied from bitly. After saving `.Renviron` you
 will need to restart your R session and can then test that your token is
 function correctly by running,