Merge branch 'main' into plausible

.Rbuildignore

@@ -5,3 +5,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^README\.Rmd$

DESCRIPTION

@@ -12,16 +12,19 @@ Authors@R: c(
 Description: This is a private template for use by Poisson consulting
     packages.  Please don't use for your own code.
 License: MIT + file LICENSE
-Encoding: UTF-8
-Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.2
-URL: https://poissonconsulting.github.io/poissontemplate/, https://github.com/poissonconsulting/poissontemplate
+URL: https://poissonconsulting.github.io/poissontemplate/,
+    https://github.com/poissonconsulting/poissontemplate
 BugReports: https://github.com/poissonconsulting/poissontemplate/issues
-Suggests: 
-    knitr,
-    rmarkdown
-VignetteBuilder: knitr
 Imports: 
     cli,
     desc,
     yaml
+Suggests: 
+    knitr,
+    rmarkdown
+VignetteBuilder: 
+    knitr
+Encoding: UTF-8
+Roxygen: list(markdown = TRUE)
+RoxygenNote: 7.3.2.9000
+Config/Needs/website: poissonconsulting/poissontemplate

README.Rmd

@@ -0,0 +1,63 @@
+---
+output: github_document
+---
+
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>",
+  fig.path = "man/figures/README-",
+  out.width = "100%"
+)
+```
+
+
+# poissontemplate
+
+<!-- badges: start -->
+[![Lifecycle: stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
+[![R-CMD-check](https://github.com/poissonconsulting/poissontemplate/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/poissonconsulting/poissontemplate/actions/workflows/R-CMD-check.yaml)
+<!-- badges: end -->
+
+poissontemplate provides a custom [pkgdown](https://pkgdown.r-lib.org/) template for Poisson consulting packages. 
+Please don’t use it for your own package.
+
+## Setup
+
+In every package where you need to set up poissontemplate usage, run
+
+``` r
+poissontemplate::use_poisson_pkgdown()
+```
+
+## Installation
+
+### Release
+
+To install the release version from [CRAN](https://CRAN.R-project.org/package=poissontemplate).
+```r
+install.packages("poissontemplate")
+```
+
+The website for the release version is at <https://poissonconsulting.github.io/poissontemplate/>.
+
+### Development
+
+To install the development version from [r-universe](https://poissonconsulting.r-universe.dev/poissontemplate).
+```r
+install.packages("poissontemplate", repos = c("https://poissonconsulting.r-universe.dev", "https://cloud.r-project.org"))
+```
+
+or from [GitHub](https://github.com/poissonconsulting/poissontemplate)
+```r
+# install.packages("remotes")
+remotes::install_github("poissonconsulting/poissontemplate")
+```
+
+## Relevant resources
+
+- pkgdown documentation about theming: https://pkgdown.r-lib.org/articles/customise.html#theming
+- pkgdown documentation on template packages: https://pkgdown.r-lib.org/articles/customise.html#template-packages
+

README.md

@@ -1,28 +1,55 @@
 
+<!-- README.md is generated from README.Rmd. Please edit that file -->
+
 # poissontemplate
 
 <!-- badges: start -->
+
+[![Lifecycle:
+stable](https://img.shields.io/badge/lifecycle-stable-brightgreen.svg)](https://lifecycle.r-lib.org/articles/stages.html#stable)
 [![R-CMD-check](https://github.com/poissonconsulting/poissontemplate/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/poissonconsulting/poissontemplate/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
-poissontemplate provides a custom [pkgdown](https://pkgdown.r-lib.org/) template for Poisson consulting packages. 
-Please don’t use it for your own package.
+poissontemplate provides a custom [pkgdown](https://pkgdown.r-lib.org/)
+template for Poisson consulting packages. Please don’t use it for your
+own package.
+
+## Setup
+
+In every package where you need to set up poissontemplate usage, run
+
+``` r
+poissontemplate::use_poisson_pkgdown()
+```
 
 ## Installation
 
-You can install the development version of poissontemplate from [GitHub](https://github.com/) with:
+### Release
+
+To install the release version from
+[CRAN](https://CRAN.R-project.org/package=poissontemplate).
 
 ``` r
-# install.packages("pak")
-pak::pak("poissonconsulting/poissontemplate")
+install.packages("poissontemplate")
 ```
 
-## Setup
+The website for the release version is at
+<https://poissonconsulting.github.io/poissontemplate/>.
 
-In every package where you need to set up poissontemplate usage, run
+### Development
+
+To install the development version from
+[r-universe](https://poissonconsulting.r-universe.dev/poissontemplate).
 
 ``` r
-poissontemplate::use_poisson_pkgdown()
+install.packages("poissontemplate", repos = c("https://poissonconsulting.r-universe.dev", "https://cloud.r-project.org"))
+```
+
+or from [GitHub](https://github.com/poissonconsulting/poissontemplate)
+
+``` r
+# install.packages("remotes")
+remotes::install_github("poissonconsulting/poissontemplate")
 ```
 
 Then contact the owner of Poisson consulting Plausible account to have a domain set up.
@@ -36,5 +63,7 @@ includes:
 
 ## Relevant resources
 
-- pkgdown documentation about theming: https://pkgdown.r-lib.org/articles/customise.html#theming
-- pkgdown documentation on template packages: https://pkgdown.r-lib.org/articles/customise.html#template-packages
+- pkgdown documentation about theming:
+  <https://pkgdown.r-lib.org/articles/customise.html#theming>
+- pkgdown documentation on template packages:
+  <https://pkgdown.r-lib.org/articles/customise.html#template-packages>

_pkgdown.yml

@@ -1,4 +1,3 @@
 url: https://poissonconsulting.github.io/poissontemplate/
 template:
   package: poissontemplate
-

inst/pkgdown/_pkgdown.yml

@@ -17,8 +17,20 @@ authors:
   Ayla Pearson:
     href: https://www.poissonconsulting.ca/author/ayla-pearson/
   Kirill Müller:
-    href: https://github.com/krlmlr
+    href: https://krlmlr.info
   Nadine Hussein:
     href: https://www.poissonconsulting.ca/author/nadine-hussein/
   Evan Amies-Galonski:
     href: https://www.poissonconsulting.ca/author/evan-amies-galonski/
+  Nicole Hill:
+    href: https://www.poissonconsulting.ca/author/nicole-hill/
+  Seb Dalgarno:
+    href: https://www.poissonconsulting.ca/author/seb-dalgarno/
+  Robyn Irvine:
+    href: https://www.poissonconsulting.ca/author/robyn-irvine/
+  Andrea Kortello:
+    href: https://www.poissonconsulting.ca/author/andrea-kortello/
+  Sarah Lyons:
+    href: https://www.poissonconsulting.ca/author/sarah-lyons/
+  Duncan Kennedy:
+    href: https://www.poissonconsulting.ca/author/duncan-kennedy/

poissontemplate.Rproj

@@ -1,4 +1,5 @@
 Version: 1.0
+ProjectId: 002ac308-ddf2-4933-8986-d77f59e0434e
 
 RestoreWorkspace: No
 SaveWorkspace: No