Skip to content

Commit 4eb1a99

Browse files
Revise README for Open Workflow Specification (#1588)
Updated references from 'Serverless Workflow Specification' to 'Open Workflow Specification' in README.
1 parent 9fec75f commit 4eb1a99

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/serverlessworkflow/sdk-java)
1+
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/open-workflow-specification/sdk-java)
22

3-
# Serverless Workflow Specification - Java SDK
3+
# Open Workflow Specification - Java SDK
44

5-
Provides the Java API for the [Serverless Workflow Specification](https://github.com/serverlessworkflow/specification)
5+
Provides the Java API for the [Serverless Workflow Specification](https://github.com/open-workflow-specification/specification)
66

77
With the SDK you can:
88

@@ -15,12 +15,12 @@ With the SDK you can:
1515

1616
| Latest Releases | Conformance to spec version |
1717
| :------------------------------------------------------------------------------------: | :----------------------------------------------------------------------: |
18-
| [7.x](https://github.com/serverlessworkflow/sdk-java/releases/tag/7.5.0.Final)| [v1.0.0](https://github.com/serverlessworkflow/specification/tree/1.0.x) |
19-
| [5.x](https://github.com/serverlessworkflow/sdk-java/releases/tag/5.1.0.Final)| [v0.8](https://github.com/serverlessworkflow/specification/tree/0.8.x) |
20-
| [4.x](https://github.com/serverlessworkflow/sdk-java/releases/tag/4.1.0.Final)| [v0.8](https://github.com/serverlessworkflow/specification/tree/0.8.x) |
21-
| [3.0.0.Final](https://github.com/serverlessworkflow/sdk-java/releases/tag/3.0.0.Final)| [v0.7](https://github.com/serverlessworkflow/specification/tree/0.7.x) |
22-
| [2.0.0.Final](https://github.com/serverlessworkflow/sdk-java/releases/tag/2.0.0.Final)| [v0.6](https://github.com/serverlessworkflow/specification/tree/0.6.x) |
23-
| [1.0.3.Final](https://github.com/serverlessworkflow/sdk-java/releases/tag/1.0.3.Final)| [v0.5](https://github.com/serverlessworkflow/specification/tree/0.5.x) |
18+
| [7.x](https://github.com/open-workflow-specification/sdk-java/releases/tag/7.5.0.Final)| [v1.0.0](https://github.com/open-workflow-specification/specification/tree/1.0.x) |
19+
| [5.x](https://github.com/open-workflow-specification/sdk-java/releases/tag/5.1.0.Final)| [v0.8](https://github.com/open-workflow-specification/specification/tree/0.8.x) |
20+
| [4.x](https://github.com/open-workflow-specification/sdk-java/releases/tag/4.1.0.Final)| [v0.8](https://github.com/open-workflow-specification/specification/tree/0.8.x) |
21+
| [3.0.0.Final](https://github.com/open-workflow-specification/sdk-java/releases/tag/3.0.0.Final)| [v0.7](https://github.com/open-workflow-specification/specification/tree/0.7.x) |
22+
| [2.0.0.Final](https://github.com/open-workflow-specification/sdk-java/releases/tag/2.0.0.Final)| [v0.6](https://github.com/open-workflow-specification/specification/tree/0.6.x) |
23+
| [1.0.3.Final](https://github.com/open-workflow-specification/sdk-java/releases/tag/1.0.3.Final)| [v0.5](https://github.com/open-workflow-specification/specification/tree/0.5.x) |
2424

2525
> **Note:** `6.0.0.Final` (planned for spec **v0.9**) is intentionally **skipped** to leave room for anyone who wants to work on it.
2626
@@ -40,7 +40,7 @@ With the SDK you can:
4040
To build project and run tests locally:
4141

4242
```
43-
git clone https://github.com/serverlessworkflow/sdk-java.git
43+
git clone https://github.com/open-workflow-specification/sdk-java.git
4444
mvn clean install
4545
```
4646

@@ -55,7 +55,7 @@ Add the following dependencies to your pom.xml `dependencies` section:
5555
<dependency>
5656
<groupId>io.serverlessworkflow</groupId>
5757
<artifactId>serverlessworkflow-api</artifactId>
58-
<version>7.3.0.Final</version>
58+
<version>RELEASE_VERSION</version>
5959
</dependency>
6060
```
6161

@@ -64,7 +64,7 @@ Add the following dependencies to your pom.xml `dependencies` section:
6464
Add the following dependencies to your build.gradle `dependencies` section:
6565

6666
```text
67-
implementation("io.serverlessworkflow:serverlessworkflow-api:7.5.0.Final")
67+
implementation("io.serverlessworkflow:serverlessworkflow-api:RELEASE_VERSION")
6868
```
6969

7070
## How to Use
@@ -76,7 +76,7 @@ There are, roughly speaking, two kind of users of this SDK:
7676
### Implementing your own runtime
7777

7878
For those ones interested on implementing their own runtime, this SDK provides an easy way to load an in memory representation of a given workflow definition.
79-
This in-memory representation consists of a hierarchy of POJOS directly generated from the Serverless Workflow specification [schema](api/src/main/resources/schema/workflow.yaml), which ensures the internal representation is aligned with the specification schema. The root of the hierarchy is `io.serverlessworkflow.api.types.Workflow` class
79+
This in-memory representation consists of a hierarchy of POJOS directly generated from the Open Workflow specification [schema](api/src/main/resources/schema/workflow.yaml), which ensures the internal representation is aligned with the specification schema. The root of the hierarchy is `io.serverlessworkflow.api.types.Workflow` class
8080

8181
### Reading workflow definition from JSON/YAML source
8282

@@ -137,5 +137,5 @@ For additional writing helper methods, check [WorkflowWriter](api/src/main/java/
137137

138138
### Reference implementation
139139

140-
The reference implementation provides a ready-to-use runtime that supports the Serverless Workflow Specification. It includes a workflow execution engine, validation utilities, and illustrative examples to help you quickly test and deploy your workflows. For details on usage, configuration, and supported features, see [readme](impl/README.md).
140+
The reference implementation provides a ready-to-use runtime that supports the Open Workflow Specification. It includes a workflow execution engine, validation utilities, and illustrative examples to help you quickly test and deploy your workflows. For details on usage, configuration, and supported features, see [readme](impl/README.md).
141141

0 commit comments

Comments
 (0)