Skip to content

Commit 8234696

Browse files
actions-userpratikunterwegs
authored andcommitted
Automatic readme update
1 parent 24a7cfd commit 8234696

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,11 @@ VIMC GitHub organisation. Replace all instances of
3131
2. Edit the files in `R/`, `tests/`, and `vignettes/` to suit your
3232
package;
3333

34-
3. Add spell check by running
35-
`usethis::use_spell_check(lang = "en-GB")`;
36-
37-
4. Remove these instructions from `README.Rmd`, and re-render the `.md`
38-
file using `devtools::render_readme()`.
34+
3. Remove these instructions from `README.Rmd`. Then, either let the
35+
automated GitHub Actions workflow update `README.md` once the change
36+
is pushed to GitHub, or disable the workflow by removing the file
37+
`.github/workflows/render-readme.yaml`, and manually re-render the
38+
`.md` file using `devtools::render_readme()`.
3939

4040
## Installation
4141

@@ -75,6 +75,26 @@ prefer to hide them to keep focus on the package functionality.
7575
Add information and links to related projects, such as research papers
7676
or packages, here.
7777

78+
An example citation would be Echeverria-Londono et al.
79+
([2021](#ref-echeverria-londono2021)).
80+
7881
## References
7982

80-
Space for references: REMOVE this text.
83+
**Space for references: REMOVE this sub-section if there are no
84+
references. References, if any, should appear below this text. Remove
85+
this text in packages.**
86+
87+
<div id="refs" class="references csl-bib-body hanging-indent"
88+
entry-spacing="0">
89+
90+
<div id="ref-echeverria-londono2021" class="csl-entry">
91+
92+
Echeverria-Londono, Susy, Xiang Li, Jaspreet Toor, Margaret J. De
93+
Villiers, Shevanthi Nayagam, Timothy B. Hallett, Kaja Abbas, et al.
94+
2021. “How Can the Public Health Impact of Vaccination Be Estimated?”
95+
*BMC Public Health* 21 (1): 2049.
96+
<https://doi.org/10.1186/s12889-021-12040-9>.
97+
98+
</div>
99+
100+
</div>

0 commit comments

Comments
 (0)