Chapter 7 README

It is useful to have a README file for the package, where we can provide high-level description of the package and its goals, code to install the package and some basic examples. To create a README.md file, execute:

use_readme_md()

If you would like to allert about the stage of the development of your package (a lifecycle badge):

use_lifecycle_badge("experimental")

To read more about Lifecycle stages, see: https://lifecycle.r-lib.org/articles/stages.html

There are some other badges you can add into your README file. See help topic for usethis::use_badges() function

If your README file will contain some examples, then it might be easier to create a README.Rmd file first and then use it to build the final README.md file. To do this use use_readme_rmd() function instead of use_readme_md().