Skip to content

Commit

Permalink
Pimped out the README with badges and link to the built vignette.
Browse files Browse the repository at this point in the history
  • Loading branch information
LTLA committed Apr 24, 2024
1 parent 4d31bee commit b684a19
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# R client for the SewerRat API

[![R CMD check](https://github.com/ArtifactDB/SewerRat-R/actions/workflows/r-cmd-check.yaml/badge.svg)](https://github.com/ArtifactDB/SewerRat-R/actions/workflows/r-cmd-check.yaml)
[![Build pkgdown](https://github.com/ArtifactDB/SewerRat-R/actions/workflows/build-pkgdown.yaml/badge.svg)](https://github.com/ArtifactDB/SewerRat-R/actions/workflows/build-pkgdown.yaml)

Pretty much as it says on the can; check out the [SewerRat](https://github.com/ArtifactDB/SewerRat) repository for some background.
The [user's guide](vignettes/userguide.Rmd) contains instructions on how to use this client with an existing SewerRat service.
The [user's guide](https://artifactdb.github.io/SewerRat-R/articles/userguide.html) contains instructions on how to use this client with an existing SewerRat service.

0 comments on commit b684a19

Please sign in to comment.