rename package

.Rbuildignore

@@ -28,3 +28,4 @@ super-linter.log
 cache/
 .lintr
 .githooks
+^vignettes/articles$

.env

@@ -1,7 +1,7 @@
 # dotenv-linter:off QuoteCharacter
 # dotenv-linter:off UnorderedKey
 # this is image name *root*, because the image target gets prepended later
-IMAGE_NAME_ROOT="module2app"
+IMAGE_NAME_ROOT="niffler"
 # GHCR includes this in the tag, so we take the same name
 # https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry
 IMAGE_OWNER="dataheld"

DESCRIPTION

@@ -1,5 +1,5 @@
-Package: module2app
-Title: Development helpers for working with shiny modules
+Package: niffler
+Title: Shiny development helpers
 Version: 0.0.0.9000
 Authors@R: 
     c(
@@ -16,9 +16,9 @@ Authors@R:
       )
     )
 Description: 
-    Lets you quickly create shiny apps from modules.
-URL: https://github.com/dataheld/module2app
-BugReports: https://github.com/dataheld/module2app/issues
+    Helpers for shiny development.
+URL: https://github.com/dataheld/niffler
+BugReports: https://github.com/dataheld/niffler/issues
 License: file LICENSE
 Encoding: UTF-8
 LazyData: true
@@ -35,3 +35,4 @@ Suggests:
     testthat (>= 3.0.0)
 Config/testthat/edition: 3
 Config/testthat/parallel: true
+Config/Needs/website: rmarkdown

README.md

@@ -1,3 +1,38 @@
-# module2app
+# niffler
 
-Development helper for working with shiny modules
+> "Long-snouted, burrowing creatures native to Britain with a penchant for anything shiny."
+> -— [Pottermore](https://harrypotter.fandom.com/wiki/Niffler)
+
+## Overview
+
+niffler is a loose collection of helpers for your shiny development.
+It is *not* a full-blown framework like [golem](https://thinkr-open.github.io/golem/),
+but a lightweight time- and line-saver.
+
+It can help with:
+
+- modules
+- testing
+- ... and more
+
+
+## Installation
+
+```r
+# install.packages("pak")
+pak::pak("dataheld/niffler")
+```
+
+Notice that niffler is a *development*-time dependency;
+your shiny app should not need it to work,
+and it thus *might not need it in your `DESCRIPTION`*.
+
+If you use it for tests, you can include it as a `Suggests`.
+
+If you don't need it for tests,
+but want to otherwise record that you used it for development,
+consider an [extra dependency](https://pak.r-lib.org/reference/package-dependency-types.html#extra-dependencies):
+
+```DESCRIPTION
+Config/Needs/website: dataheld/niffler
+```

tests/testthat.R

@@ -7,6 +7,6 @@
 # * https://testthat.r-lib.org/articles/special-files.html
 
 library(testthat)
-library(module2app)
+library(niffler)
 
-test_check("module2app")
+test_check("niffler")

vignettes/.gitignore

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

vignettes/articles/module2app.Rmd

@@ -0,0 +1,25 @@
+---
+title: "niffler"
+---
+
+
+```{r, include = FALSE}
+knitr::opts_chunk$set(
+  collapse = TRUE,
+  comment = "#>"
+)
+```
+
+```{r setup}
+library(niffler)
+```
+
+
+# Testbed for Modules
+
+## Reactive and non-Reactive Inputs
+
+Notice that it is the responsibility of your module server to
+assert whichever kinds of inputs it expects.
+Consider these [recommendations on server inputs](https://mastering-shiny.org/scaling-modules.html#server-inputs)
+on how to do this.