Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated readme to provide clear description of the current repository status.
  • Loading branch information
tlalfano authored Nov 17, 2023
1 parent 94aecc9 commit 77576b7
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,21 @@
[![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)
[![Gem Version](https://badge.fury.io/rb/temporalio.svg)](https://rubygems.org/gems/temporalio)

⚠️ INACTIVE ⚠️

This repository is not under active development, is client only, and is not compatible with Ruby 3+.

To see a list of Temporal's fully supported SDKs, check out the [Temporal documentation](https://docs.temporal.io/dev-guide/sdks#official-sdks).

***
[Temporal](https://temporal.io/) is a distributed, scalable, durable, and highly available
orchestration engine used to execute asynchronous long-running business logic in a scalable and
resilient way.

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

⚠️ UNDER DEVELOPMENT

The Ruby SDK is under development. There are no compatibility guarantees at this time.

At this point the SDK only supports the **Temporal Client** capabilities:
At this point this experimental repository only implements the **Temporal Client** capabilities:

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

0 comments on commit 77576b7

Please sign in to comment.