Skip to content

Commit

Permalink
Adapt to new pkgdown v1.4 workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
mrustl committed Sep 9, 2019
1 parent e5f7361 commit fe7a73e
Show file tree
Hide file tree
Showing 3 changed files with 56 additions and 4 deletions.
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.Rproj.user
.Rhistory
.RData
.Ruserdata

# and deploys the website to "gh-pages" branch
docs
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,29 @@

Read Sewer Condition Data according to DWA-M 150 XML format

## 1. Install from GitHub
## Installation

For details on how to install KWB-R packages checkout our [installation tutorial](https://kwb-r.github.io/kwb.pkgbuild/articles/install.html).

```r
if (! require("devtools")) {
install.packages("devtools")
### Optionally: specify GitHub Personal Access Token (GITHUB_PAT)
### See here why this might be important for you:
### https://kwb-r.github.io/kwb.pkgbuild/articles/install.html#set-your-github_pat

# Sys.setenv(GITHUB_PAT = "mysecret_access_token")

# Install package "remotes" from CRAN
if (! require("remotes")) {
install.packages("remotes", repos = "https://cloud.r-project.org")
}

devtools::install_github(repo = "kwb-r/kwb.dwa.m150", dependencies = TRUE)
# Install KWB package 'kwb.dwa.m150' from GitHub

remotes::install_github("kwb-r/kwb.dwa.m150")
```

# Documentation

Release: [https://kwb-r.github.io/kwb.dwa.m150](https://kwb-r.github.io/kwb.dwa.m150)

Development: [https://kwb-r.github.io/kwb.dwa.m150/dev](https://kwb-r.github.io/kwb.dwa.m150/dev)
28 changes: 28 additions & 0 deletions index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[![Appveyor build status](https://ci.appveyor.com/api/projects/status/iicavfew3kfs20va/branch/master?svg=true)](https://ci.appveyor.com/project/KWB-R/kwb-dwa-m150/branch/master)
[![Build Status](https://travis-ci.org/KWB-R/kwb.dwa.m150.svg?branch=master)](https://travis-ci.org/KWB-R/kwb.dwa.m150)
[![codecov](https://codecov.io/github/KWB-R/kwb.dwa.m150/branch/master/graphs/badge.svg)](https://codecov.io/github/KWB-R/kwb.dwa.m150)
[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/kwb.dwa.m150)](https://cran.r-project.org/package=kwb.dwa.m150)

Read Sewer Condition Data according to DWA-M 150 XML format

## Installation

For details on how to install KWB-R packages checkout our [installation tutorial](https://kwb-r.github.io/kwb.pkgbuild/articles/install.html).

```r
### Optionally: specify GitHub Personal Access Token (GITHUB_PAT)
### See here why this might be important for you:
### https://kwb-r.github.io/kwb.pkgbuild/articles/install.html#set-your-github_pat

# Sys.setenv(GITHUB_PAT = "mysecret_access_token")

# Install package "remotes" from CRAN
if (! require("remotes")) {
install.packages("remotes", repos = "https://cloud.r-project.org")
}

# Install KWB package 'kwb.dwa.m150' from GitHub

remotes::install_github("kwb-r/kwb.dwa.m150")
```

0 comments on commit fe7a73e

Please sign in to comment.