Skip to content

[DOC] Improve project description and README #39

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 6 commits into from
Sep 1, 2021
Merged

[DOC] Improve project description and README #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
658b4fb
Update description & organize doc
csouchet Aug 31, 2021
aa19f30
Update readme
csouchet Aug 31, 2021
9deefc4
Update the description (like readme) & the title corresponding to the…
csouchet Aug 31, 2021
5725ee7
Merge branch 'main' into 2-update_description
csouchet Sep 1, 2021
004d0eb
Merge branch 'main' into 2-update_description
csouchet Sep 1, 2021
2d9c4da
Apply suggestions from code review
csouchet Sep 1, 2021
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
4 changes: 2 additions & 2 deletions DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Package: bpmnVisualization
Type: Package
Title: BPMN Visualization - R Package
Title: Visualize process execution data on BPMN diagrams
Version: 0.1.0
Authors@R: c(person("Celine", "Souchet", role = c("aut", "cre"), email = "celine.souchet@bonitasoft.com"),
person("Thomas", "Bouffard", role = "aut"))
Description: A R package which embeds BPMN Visualization.
Description: To visualize the execution data of the processes on BPMN diagrams, using overlays, style customization and interactions, with BPMN Visualization.
License: Apache License (== 2)
Copyright: Bonitasoft S.A.
URL: https://github.com/process-analytics/bpmn-visualization-R
Expand Down
21 changes: 11 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@
</div>
<br>

This project is an R interface to the [BPMN Visualization](https://github.com/process-analytics/bpmn-visualization-js) library.
This project 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
Expand All @@ -35,16 +37,8 @@ library(bpmnVisualization)
### Load the BPMN file
`bpmnVisualization` accepts a BPMN file (or an XML document):

Load an BPMN example provided by the package

The diagrams files are taken from the [BPMN 2.0 examples non-normative machine readable files](https://www.omg.org/spec/BPMN/2.0)
- Email_Voting.bpmn
- Nobel_Prize_Process.bpmn
- Order_Process_for_Pizza_V4.bpmn
- Travel_Booking.bpmn

```r
bpmn_file <- system.file("examples/Email_Voting.bpmn", package = "bpmnVisualization")
bpmn_file <- system.file("examples/Email_Voting.bpmn", package = "bpmnVisualization") # File from the package
```

Or
Expand All @@ -62,6 +56,13 @@ Or
bpmn_file <- "<?xml version="1.0" encoding="UTF-8"?> ...xml_content"
```

💡 The package provides some [BPMN examples](./inst/examples). \
Copy link
Member

@tbouffard tbouffard Sep 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice ❤️

They are taken from the [BPMN 2.0 examples non-normative machine readable files](https://www.omg.org/spec/BPMN/2.0).
- Email_Voting.bpmn
- Nobel_Prize_Process.bpmn
- Order_Process_for_Pizza_V4.bpmn
- Travel_Booking.bpmn

### Display the BPMN diagram
```r
bpmnVisualization::display(bpmn_file)
Expand Down