diff --git a/README.Rmd b/README.Rmd index 66892830..5657bb1b 100644 --- a/README.Rmd +++ b/README.Rmd @@ -1,7 +1,8 @@ --- +always_allow_html: true output: rmarkdown::github_document -bibliography: "README-refs.bib" +bibliography: "inst/REFERENCES.bib" --- @@ -61,6 +62,13 @@ remotes::install_github("tlverse/tmle3") --- +## Issues + +If you encounter any bugs or have any specific feature requests, please [file an +issue](https://github.com/tlverse/tmle3/issues). + +--- + ## Getting Started The best place to get started is the "Framework Overview" document, which @@ -69,16 +77,34 @@ https://tlverse.org/tmle3/articles/framework.html. --- -## Issues +## Contributions -If you encounter any bugs or have any specific feature requests, please [file an -issue](https://github.com/tlverse/tmle3/issues). +Contributions are very welcome. Interested contributors should consult our +[contribution +guidelines](https://github.com/tlverse/tmle3/blob/master/CONTRIBUTING.md) prior +to submitting a pull request. + +--- + +## Citation + +After using the `tmle3` R package, please cite the following: + + @software{coyle2021tmle3-rpkg, + author = {Coyle, Jeremy R}, + title = {{tmle3}: The Extensible {TMLE} Framework}, + year = {2021}, + howpublished = {\url{https://github.com/tlverse/tmle3}}, + note = {{R} package version 0.2.0}, + url = {https://doi.org/}, + doi = {} + } --- ## License -© 2017-2020 [Jeremy R. Coyle](https://github.com/jeremyrcoyle) +© 2017-2021 [Jeremy R. Coyle](https://github.com/jeremyrcoyle) The contents of this repository are distributed under the GPL-3 license. See file `LICENSE` for details. diff --git a/README-refs.bib b/inst/REFERENCES.bib similarity index 100% rename from README-refs.bib rename to inst/REFERENCES.bib