diff --git a/README.md b/README.md index 21989dc..b4af410 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,9 @@ GitHub release (latest by date including pre-releases) + + CRAN release (latest by date) + Build @@ -22,11 +25,11 @@
- + `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. - + ## ♻️ Usage ### Installation @@ -37,8 +40,16 @@ It can be installed from the R console: install.packages('devtools') ``` - -#### Install _bpmnVisualizationR_ from GitHub + +#### 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 @@ -54,7 +65,7 @@ Then, make the library available to the current R project: ```r library(bpmnVisualizationR) ``` - + ### Load the BPMN file `bpmnVisualizationR` accepts a BPMN file (or an XML document): diff --git a/index.md b/index.md index 5fa0219..704f6ae 100644 --- a/index.md +++ b/index.md @@ -3,6 +3,7 @@ # bpmnVisualizationR +[![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) @@ -17,6 +18,14 @@ It is made possible by [htmlwidgets](http://www.htmlwidgets.org/), which provide ## 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/bpmn-visualization-R@v0.3.2")