df-mcom
diff --git a/‎R/readme.R
Lines changed: 9 additions & 2 deletions b/‎R/readme.R
Lines changed: 9 additions & 2 deletions
diff --git a/‎man/use_readme_rmd.Rd
Lines changed: 9 additions & 2 deletions b/‎man/use_readme_rmd.Rd
Lines changed: 9 additions & 2 deletions
@@ -1,8 +1,8 @@
 #' Create README files
 #'
 #' @description
-#' Creates skeleton README files with sections for
-#' * a high-level description of the package and its goals
+#' Creates skeleton README files with possible stubs for
+#' * a high-level description of the project/package and its goals
 #' * R code to install from GitHub, if GitHub usage detected
 #' * a basic example
 #'
@@ -17,6 +17,13 @@
 #' An example workflow can be found in the `examples/` directory here:
 #' <https://github.com/r-lib/actions/>.
 #'
+#' If the current project is a Git repo, then `use_readme_rmd()` automatically
+#' configures a pre-commit hook that helps keep `README.Rmd` and `README.md`,
+#' synchronized. The hook creates friction if you try to commit when
+#' `README.Rmd` has been edited more recently than `README.md`. If this hook
+#' causes more problems than it solves for you, it is implemented in
+#' `.git/hooks/pre-commit`, which you can modify or even delete.
+#'
 #' @inheritParams use_template
 #' @seealso The [important files
 #'   section](https://r-pkgs.org/release.html#important-files) of [R