Skip to content

Commit 5b2429e

Browse files
authored
Update README.md (#152)
Updated readme to provide clear description of the current repository status.
1 parent 94aecc9 commit 5b2429e

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,21 @@
44
[![Build](https://github.com/temporalio/sdk-ruby/actions/workflows/build-native-ext.yml/badge.svg)](https://github.com/temporalio/sdk-ruby/actions/workflows/build-native-ext.yml?query=branch%3Amain+event%3Arelease)
55
[![Gem Version](https://badge.fury.io/rb/temporalio.svg)](https://rubygems.org/gems/temporalio)
66

7+
⚠️ INACTIVE ⚠️
8+
9+
This repository is not under active development, is client only, and is not compatible with Ruby 3+.
10+
11+
To see a list of Temporal's fully supported SDKs, check out the [Temporal documentation](https://docs.temporal.io/dev-guide/sdks#official-sdks).
12+
13+
***
714
[Temporal](https://temporal.io/) is a distributed, scalable, durable, and highly available
815
orchestration engine used to execute asynchronous long-running business logic in a scalable and
916
resilient way.
1017

1118
"Temporal Ruby SDK" is the framework for authoring workflows and activities using the Ruby
1219
programming language.
1320

14-
⚠️ UNDER DEVELOPMENT
15-
16-
The Ruby SDK is under development. There are no compatibility guarantees at this time.
17-
18-
At this point the SDK only supports the **Temporal Client** capabilities:
21+
At this point this experimental repository only implements the **Temporal Client** capabilities:
1922

2023
- Starting a workflow (defined in any other SDK)
2124
- Interacting with a workflow (cancelling, querying, signalling, etc)

0 commit comments

Comments
 (0)