Skip to content

Update README.md #983

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #983

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
feeb80a
Update README.md
ibarrajo Feb 25, 2025
5bda6f1
Update README.md
ibarrajo Feb 25, 2025
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
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# Java framework for Cadence [![Build Status](https://badge.buildkite.com/0c96b8b74c0921208e898c10a602e2fe9ecb7641c2befee0e7.svg?theme=github&branch=master)](https://buildkite.com/uberopensource/cadence-java-client) [![Javadocs](https://www.javadoc.io/badge/com.uber.cadence/cadence-client.svg)](https://www.javadoc.io/doc/com.uber.cadence/cadence-client) [![codecov](https://codecov.io/gh/cadence-workflow/cadence-java-client/graph/badge.svg?token=eVBGf4EmXr)](https://codecov.io/gh/cadence-workflow/cadence-java-client)


[Cadence](https://github.com/uber/cadence) is a distributed, scalable, durable, and highly available orchestration engine we developed at Uber Engineering to execute asynchronous long-running business logic in a scalable and resilient way.
[Cadence](https://github.com/cadence-workflow/cadence) is a distributed, scalable, durable, and highly available orchestration engine we developed at Uber Engineering to execute asynchronous long-running business logic in a scalable and resilient way.

`cadence-client` is the framework for authoring workflows and activities in Java.

If you are authoring in Go, see [Go Cadence Client](https://github.com/uber-go/cadence-client).
If you are authoring in Go, see [Go Cadence Client](https://github.com/cadence-workflow/cadence-go-client).

## Samples

For samples, see [Samples for the Java Cadence client](https://github.com/uber/cadence-java-samples).
For samples, see [Samples for the Java Cadence client](https://github.com/cadence-workflow/cadence-java-samples).

## Run Cadence Server

Run Cadence Server using Docker Compose:

curl -O https://raw.githubusercontent.com/uber/cadence/master/docker/docker-compose.yml
curl -O https://raw.githubusercontent.com/cadence-workflow/cadence/master/docker/docker-compose.yml
docker-compose up

If this does not work, see instructions for running the Cadence Server at https://github.com/uber/cadence/blob/master/README.md.
If this does not work, see [instructions](https://github.com/cadence-workflow/cadence/blob/master/README.md) for running the Cadence Server

## Get CLI

[CLI is avaialable as an executable or as a docker image](https://github.com/uber/cadence/blob/master/tools/cli/README.md)
[CLI is available as an executable or as a docker image](https://github.com/cadence-workflow/cadence/blob/master/tools/cli/README.md)

## Build a configuration

Expand All @@ -40,7 +40,7 @@ or to *build.gradle*:

## Documentation

The documentation on how to use the Cadence Java client is [here](https://cadenceworkflow.io/docs/java-client/).
The documentation on how to use the Cadence Java client is [here](https://cadenceworkflow.io/docs/java-client).

Javadocs for the client API are located [here](https://www.javadoc.io/doc/com.uber.cadence/cadence-client).

Expand Down