R/badges.R
add_badge_comments.RdAdd special marker comments delimiting the badge section of package README
add_badge_comments(x = "README.md", f = NULL)
| x | Name of README file |
|---|---|
| f | Absolute path to file (can be used instead of |
Path to modified readme file (invisibly)
Badge comment lines are required for
usethis::use_badge and friends to automagically add badges to
a README.
add_badge_comments will only add badge comments if they are not yet
present. If there are some badges present then will add marker comments on
either side. Will give a warning and do nothing if badge lines are not
contiguous