update readme

DESCRIPTION

@@ -3,7 +3,7 @@ Type: Package
 Title: Inquiry app for expert elicitation
 Version: 24.11.0
 Authors@R: c(person("Antonia", "Runge", email = "antonia.runge@inwt-statistics.de", role = c("aut", "cre")))
-Description: An app for creating Inquiry templates, conducting a survey, and downloading the results.
+Description: An app for creating Inquiry templates, conducting a survey, and downloading the results based on the shinysurveys package.
 License: GPL (>= 3)
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)

README.md

@@ -1 +1,18 @@
 # InquiryR
+
+An app for creating Inquiry templates, conducting a survey, and downloading the results based on the shinysurveys package.
+
+## Release notes:
+
+- see `NEWS.md`
+
+## Notes for developers
+
+When adding information to the _help_ sites, _docstrings_ or the _vignette_ of this 
+package, please update documentation locally as follows. The documentation of
+the main branch is build automatically via github action.
+
+```R
+devtools::document() # or CTRL + SHIFT + D in RStudio
+devtools::build_site()
+```