Skip to content

docs: update README for CRAN install, add Shiny app badge, fix DOI badge #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TNRiley merged 1 commit into from
Jun 17, 2026
+14 −2
Merged

docs: update README for CRAN install, add Shiny app badge, fix DOI badge #261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@
[![CRAN status](https://www.r-pkg.org/badges/version/CiteSource)](https://CRAN.R-project.org/package=CiteSource)
[![CRAN downloads](https://cranlogs.r-pkg.org/badges/grand-total/CiteSource)](https://CRAN.R-project.org/package=CiteSource)
[![Status](https://img.shields.io/badge/Status-Active-brightgreen)](https://github.com/ESHackathon/CiteSource)
[![Launch Shiny App](https://img.shields.io/badge/Launch-Shiny%20App-blue?logo=r)](https://litrev.shinyapps.io/CiteSource/)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![DOI](https://img.shields.io/badge/DOI-10.1038/s41586--020--2649--2-blue)](https://doi.org/10.1017/rsm.2026.10084)
[![DOI](https://img.shields.io/badge/DOI-10.1017/rsm.2026.10084-blue)](https://doi.org/10.1017/rsm.2026.10084)
<!-- badges: end -->

## About the Package
Expand Down Expand Up @@ -51,7 +52,18 @@ Once records have been processed, users are able to export data in .csv, .ris, a
## Getting Started
**Installation**

Install CiteSource in R with remotes::install_github("ESHackathon/CiteSource")
Install the released version of CiteSource from CRAN:

```r
install.packages("CiteSource")
```

Or install the development version from GitHub:

```r
# install.packages("remotes")
remotes::install_github("ESHackathon/CiteSource")
```

**Vignettes**

Expand Down
Loading