Skip to content

docs: update the documentation after CRAN publication #205

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
csouchet merged 2 commits into from
Feb 22, 2023
Merged

docs: update the documentation after CRAN publication #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
66547ea
- add badge in the README and index.md for CRAN publication
csouchet Feb 21, 2023
a9df3b9
Update how to install from CRAN in the README.md and index.md
csouchet Feb 21, 2023
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
21 changes: 16 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
<a href="https://github.com/process-analytics/bpmn-visualization-R/releases">
<img alt="GitHub release (latest by date including pre-releases)" src="https://img.shields.io/github/v/release/process-analytics/bpmn-visualization-R?label=changelog&include_prereleases">
</a>
<a href="https://cran.r-project.org/package=bpmnVisualizationR">
<img alt="CRAN release (latest by date)" src="https://www.r-pkg.org/badges/version/bpmnVisualizationR">
</a>
<a href="https://github.com/process-analytics/bpmn-visualization-R/actions/workflows/R-CMD-check.yaml">
<img alt="Build" src="https://github.com/process-analytics/bpmn-visualization-R/workflows/R-CMD-check/badge.svg">
</a>
Expand All @@ -22,11 +25,11 @@
</div>
<br>

<!-- duplicated with README.md -->
<!-- duplicated with index.md -->
`bpmnVisualizationR` is an R package for visualizing process execution data on BPMN diagrams, using overlays, style customization and interactions.

It is made possible by [htmlwidgets](http://www.htmlwidgets.org/), which provides an easy-to-use framework for bringing together R and the [bpmn-visualization](https://github.com/process-analytics/bpmn-visualization-js) TypeScript library.
<!-- END OF duplicated with README.md -->
<!-- END OF duplicated with index.md -->

## ♻️ Usage
### Installation
Expand All @@ -37,8 +40,16 @@ It can be installed from the R console:
install.packages('devtools')
```

<!-- duplicated with README.md -->
#### Install _bpmnVisualizationR_ from GitHub
<!-- duplicated with index.md -->
#### Install _bpmnVisualizationR_

##### From CRAN
The latest stable version of the `bpmnVisualizationR` package can be obtained from [CRAN](https://cran.r-project.org/web/packages/bpmnVisualizationR/index.html) with the command:
```
install.packages("bpmnVisualizationR")
```

##### From GitHub

To install a dedicated version (available versions can be found in the [GitHub releases page](https://github.com/process-analytics/bpmn-visualization-R/releases)), run:
```r
Expand All @@ -54,7 +65,7 @@ Then, make the library available to the current R project:
```r
library(bpmnVisualizationR)
```
<!-- END OF duplicated with README.md -->
<!-- END OF duplicated with index.md -->

### Load the BPMN file
`bpmnVisualizationR` accepts a BPMN file (or an XML document):
Expand Down
9 changes: 9 additions & 0 deletions index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# bpmnVisualizationR

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/bpmnVisualizationR)](https://cran.r-project.org/package=bpmnVisualizationR)
[![R-CMD-check](https://github.com/process-analytics/bpmn-visualization-R/workflows/R-CMD-check/badge.svg)](https://github.com/process-analytics/bpmn-visualization-R/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->

Expand All @@ -17,6 +18,14 @@ It is made possible by [htmlwidgets](http://www.htmlwidgets.org/), which provide
<!-- duplicated with README.md -->
## Installation

### From CRAN
The latest stable version of the `bpmnVisualizationR` package can be obtained from [CRAN](https://cran.r-project.org/web/packages/bpmnVisualizationR/index.html) with the command:
```
install.packages("bpmnVisualizationR")
```

### From GitHub

To install a dedicated version (available versions can be found in the [GitHub releases page](https://github.com/process-analytics/bpmn-visualization-R/releases)), run:
```r
devtools::install_github("process-analytics/[email protected]")
Expand Down