Skip to content

Commit 2fd7f74

Browse files
committed
[PF-26] - Readme update
- update README.md and CONTRIBUTING.md
1 parent 1e57583 commit 2fd7f74

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# How to contribute to Petriflow.js
22

3-
Petriflow.js is a Javascript library written in Typescript of Petriflow objects. The library is for those who want to integrate Petriflow
3+
Petriflow.js is a JavaScript library written in Typescript of Petriflow objects. The library is for those who want to integrate Petriflow
44
processes in their applications.
55

66
The library is updated together with the Petriflow specification.
77

8-
The library also contains functions to parse Petriflow source code from XML files to Javascript Objects and to export Javascript Objects to Petriflow source code.
8+
The library also contains functions to parse Petriflow source code from XML files to JavaScript Objects and to export JavaScript Objects to Petriflow source code.
99

1010
## Ways you can contribute
1111

@@ -26,7 +26,7 @@ If you've found a bug in the Petriflow objects or in utility functions, let us k
2626
* What you did (ideally with a code sample)
2727
* What you expected to happen
2828
* What actually happened, including any error messages or program output.
29-
* Include the version of the library, Javascript engine (or browser) with its version and OS that you used.
29+
* Include the version of the library, JavaScript engine (or browser) with its version and OS that you used.
3030

3131
### Fixing Bugs
3232

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@
1010
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=netgrif_petriflow.js&metric=coverage)](https://sonarcloud.io/dashboard?id=netgrif_petriflow.js)
1111
[![Known Vulnerabilities](https://snyk.io/test/github/netgrif/petriflow.js/badge.svg)](https://snyk.io/test/github/netgrif/petriflow.js)
1212

13-
> Petriflow in Javascript world
13+
> Petriflow in JavaScript world
1414
15-
Petriflow.js is a Javascript library of Petriflow objects, written in Typescript. The library is for those who want to integrate Petriflow
15+
Petriflow.js is a JavaScript library of Petriflow objects, written in TypeScript. The library is for those who want to integrate Petriflow
1616
processes into their applications. The library is updated together with the Petriflow specification to ensure up-to-date compatibility.
17-
The library also contains functions to parse Petriflow source code from XML files to Javascript objects and to export Javascript Objects to Petriflow source code.
17+
The library also contains functions to parse Petriflow source code from XML files to JavaScript objects and to export JavaScript Objects to Petriflow source code.
1818

1919
Full specification of Petriflow low-code language can be found at [Petriflow.com](https://petriflow.com)
2020

@@ -46,11 +46,11 @@ For applications supporting ES6+ modules you can use `import` statement, i.e.:
4646
import {PetriNet, ImportService} from "@netgrif/petriflow";
4747
```
4848

49-
The library is also published with type declaration and so your Typescript project will automatically recognize all types and enumerations.
49+
The library is also published with type declaration and so your TypeScript project will automatically recognize all types and enumerations.
5050

5151
### Petriflow model
5252

53-
The library contains every object, constant, and structure to fully interpret Petriflow source code files in Javascript.
53+
The library contains every object, constant, and structure to fully interpret Petriflow source code files in JavaScript.
5454
The root object is a [PetriNet](https://github.com/netgrif/petriflow.js/blob/master/src/lib/model/petri-net.ts) which contains all information from the Petriflow process. Every object in the library has
5555
`T.clone() => T` method to make a deep copy of the object.
5656

0 commit comments

Comments
 (0)