Skip to content

Commit

Permalink
render README
Browse files Browse the repository at this point in the history
  • Loading branch information
zkamvar committed Sep 20, 2024
1 parent fc3aa6e commit 1f5e37e
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,34 @@ experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](h
[![Codecov test
coverage](https://codecov.io/gh/hubverse-org/hubValidations/branch/main/graph/badge.svg)](https://app.codecov.io/gh/hubverse-org/hubValidations?branch=main)
[![R-CMD-check](https://github.com/hubverse-org/hubValidations/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/hubverse-org/hubValidations/actions/workflows/R-CMD-check.yaml)

<!-- badges: end -->

The goal of hubValidations is to provide a testing framework for
performing hubverse hub validations.

## Installation

You can install the development version of hubValidations like so:
### Latest

You can install the [latest version of hubValidations from the
R-universe](https://hubverse-org.r-universe.dev/hubAdmin):

``` r
install.packages("hubValidations", repos = c("https://hubverse-org.r-universe.dev", "https://cloud.r-project.org"))
```

### Development

If you want to test out new features that have not yet been released,
you can install the development version of hubValidations from
[GitHub](https://github.com/) with:

``` r
remotes::install_github("hubverse-org/hubValidations")
```

> ##### 💡 TIP
> \[!NOTE\]
>
> `hubValidations` has a dependency on the `arrow` package. For
> troubleshooting `arrow` installation problems, please consult the
Expand All @@ -49,8 +63,8 @@ contributing to this project, you agree to abide by its terms.
Interested in contributing back to the open-source Hubverse project?
Learn more about how to [get involved in the Hubverse
Community](https://hubverse.io/en/latest/overview/contribute.html)
or [how to contribute to hubValidations](.github/CONTRIBUTING.md).
Community](https://hubverse.io/en/latest/overview/contribute.html) or
[how to contribute to hubValidations](.github/CONTRIBUTING.md).
### Contributing new check functions
Expand Down

0 comments on commit 1f5e37e

Please sign in to comment.