Merge pull request #98 from Appsilon/kuba.pre-release-updates

Kuba.pre release updates

.github/workflows/pkgdown.yml

@@ -3,7 +3,7 @@
 on:
   push:
     branches:
-      - develop
+      - main
   workflow_dispatch:
 
 name: pkgdown

README.md

@@ -3,23 +3,21 @@
 > _Tools to measure performance improvements in Shiny apps._
 
 <!-- badges: start -->
+[![CRAN status](https://www.r-pkg.org/badges/version/shiny.benchmark)](https://cran.r-project.org/package=shiny.benchmark)
 [![R-CMD-check](https://github.com/Appsilon/shiny.benchmark/workflows/R-CMD-check/badge.svg)](https://github.com/Appsilon/shiny.benchmark/actions?workflow=R-CMD-check)
-[![codecov](https://codecov.io/github/Appsilon/shiny.benchmark/branch/develop/graph/badge.svg?token=JBEL2P5GIO)](https://codecov.io/github/Appsilon/shiny.benchmark)
 <!-- badges: end -->
 
 `shiny.benchmark` is a tool aimed to measure and compare the performance of different versions of a `shiny` application. Based on a list of different application versions, accessible by a git repo by its refs (commit hash or branch name), the user can write instructions to be executed using Cypress or `shinytest2`. These instructions are then evaluated by the different versions of your `shiny` application and therefore the performance's improvement/deterioration (time elapsed) are be recorded.
 
 The package is flexible enough to allow different sets of tests for the different refs as well as different package versions (via `renv`). Also, the user can replicate the tests to have more accurate measures of performance.
 
-How to install?
----------------
+## How to install?
 
 ```r
 remotes::install_github("Appsilon/shiny.benchmark")
 ```
 
-Dependencies
-------------
+## Dependencies
 
 `shiny.benchmark` can use two different engines to test the change in the performance of your application: [shinytest2](https://rstudio.github.io/shinytest2/) and [Cypress](https://www.cypress.io/).
 The latter requires `Node` (version 12 or higher) and `yarn` (version 1.22.17 or higher) to be available.
@@ -31,8 +29,7 @@ To install them on your computer, follow the guidelines on the documentation pag
 Besides that, on Linux, it might be required to install other `Cypress` dependencies.
 Check the [documentation](https://docs.cypress.io/guides/getting-started/installing-cypress#Linux-Prerequisites) to find out more.
 
-How to use it?
---------------
+## How to use it?
 
 The best way to start using `shiny.benchmark` is through an example. If you want a start point, you can use the `load_example` function. In order to use this, create a new folder in your computer and use the following code to generate an application to serve us as example for our performance checks:
 
@@ -160,21 +157,19 @@ summary(out)
 plot(out)
 ```
 
-How to contribute?
-------------------
+## How to contribute?
 
 If you want to contribute to this project please submit a regular PR, once you're done with new feature or bug fix.
 
 Reporting a bug is also helpful - please use [GitHub issues](https://github.com/Appsilon/shiny.benchmark/issues) and describe your problem as detailed as possible.
 
-Appsilon
-========
+## Appsilon
 
 <img src="https://avatars0.githubusercontent.com/u/6096772" align="right" alt="" width="6%" />
 
-Appsilon is the **Full Service Certified Posit Partner**. Learn more
+Appsilon is a **Posit (formerly RStudio) Full Service Certified Partner**. Learn more
 at [appsilon.com](https://appsilon.com).
 
-Get in touch [opensource@appsilon.com](opensource@appsilon.com)
+Get in touch [opensource@appsilon.com](mailto:opensource@appsilon.com)
 
 <a href = "https://appsilon.com/careers/" target="_blank"><img src="http://d2v95fjda94ghc.cloudfront.net/hiring.png" alt="We are hiring!"/></a>

pkgdown/_pkgdown.yml

@@ -14,6 +14,9 @@ template:
         gtag('js', new Date());
         gtag('config', 'G-RS06EY8KNQ');
       </script>
+      <script async defer src="https://buttons.github.io/buttons.js"></script>
+    before_navbar: |
+      <a href="https://shiny.tools/#shiny-benchmark" class="home"><i class="fa fa-lg fa-chevron-left"></i></a>
 
 url: https://github.com/Appsilon/shiny.benchmark/
 
@@ -34,6 +37,17 @@ navbar:
       href: https://github.com/Appsilon/shiny.benchmark
     - icon: fa-twitter fa-lg
       href: https://twitter.com/Appsilon
+    - icon: fab fa-mastodon fa-lg
+      href: https://fosstodon.org/@appsilon
+
+home:
+  sidebar:
+    structure: [star, links, license, community, citation, authors, dev]
+    components:
+      star:
+        title: GitHub
+        text: |
+          <a class="github-button" href="https://github.com/appsilon/shiny.benchmark" data-size="large" data-show-count="true" aria-label="Star appsilon/shiny.benchmark on GitHub">Star</a>
 
 reference:
 - title: Performance tests
@@ -52,3 +66,9 @@ reference:
 - title: Other
   contents:
   - '`load_example`'
+
+footer:
+  structure:
+    left: developed
+  components:
+    developed: "Developed with :heart: by [Appsilon](https://appsilon.com)."

pkgdown/extra.css

@@ -33,6 +33,17 @@ button.btn.btn-primary.btn-copy-ex {
   border-color: rgb(178, 9, 41);
 }
 
+.home {
+  left: 0px;
+  position: absolute;
+  padding: 8px 30px;
+  color: rgba(255,255,255,0.55);
+}
+
+.home:hover {
+  color: rgba(255,255,255,0.9);
+}
+
 .app-preview {
   margin: 1.5em 0.75em;
   padding: 0.25em;