Skip to contents

Use README

Source: R/use_readme_md.R
use_readme_md.Rd

Use README

Usage

use_readme_md(user = "KWB-R", domain = "github", stage = "experimental")

Arguments

user

user name or organisation under which repository defined in
parameter "repo" is hosted (default: "KWB-R")

domain

under which repository is hosted (default: "github")

stage

badge declares the developmental stage of a package, according to [https://www.tidyverse.org/lifecycle/](https://www.tidyverse.org/lifecycle/), valid arguments are: "experimental", "maturing", "stable", "retired", "archived", "dormant", "questioning"), (default: "experiment")

Value

generates README.md