Skip to content

Commit 85c9aae

Browse files
committed
chore: updates README.md
1 parent ecaf765 commit 85c9aae

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Generated **Client** with:
3636
- default `client.StartWorkflowOptions` and `client.UpdateWorkflowWithOptionsRequest`
3737
- dynamic workflow ids, update ids, and search attributes via [Bloblang expressions](#bloblang-expressions)
3838
- default timeouts, id reuse policies, retry policies, wait policies
39+
- experimental [cross-namespace (xns)](#cross-namespace-xns) support
3940

4041

4142
Generated **Worker** resources with:
@@ -52,6 +53,7 @@ Optional **CLI** with:
5253
- commands for sending signals to existing workflows
5354
- typed flags for conventiently specifying workflow, query, and signal inputs
5455

56+
5557
## Getting Started
5658
1. Install [buf](https://docs.buf.build/installation)
5759

@@ -233,7 +235,7 @@ Optional **CLI** with:
233235
type CreateFooWorkflow struct {
234236
// it embeds the generated workflow Input type that contains the workflow
235237
// input and signal helpers
236-
*examplev1.CreateFooInput
238+
*examplev1.CreateFooWorkflowInput
237239
238240
progress float32
239241
status examplev1.Foo_Status
@@ -644,7 +646,7 @@ The generated code includes resources that are compatible with the Temporal Go S
644646
645647
*__Experimental__*
646648
647-
This plugin provides experimental support for cross-namespace and/or cross-cluster integration by enabling the `enable-xns` plugin option. When enabled, the plugin will generate an additional `path/to/generated/code/<package>xns` go package containing types, methods, and helpers for calling workflows, queries, signals, and updates from other Temporal workflows via activities. The activities use [heartbeating](https://docs.temporal.io/activities#activity-heartbeat) to maintain liveness for long-running workflows or updates, and their associated timeouts can be configured using the generated options helpers. For an example of xns integration, see the [example/external](./example/external) package.
649+
This plugin provides experimental support for cross-namespace and/or cross-cluster integration by enabling the `enable-xns` plugin option. When enabled, the plugin will generate an additional `path/to/generated/code/<package>xns` go package containing types, methods, and helpers for calling workflows, queries, signals, and updates from other Temporal workflows via activities. The activities use [heartbeating](https://docs.temporal.io/activities#activity-heartbeat) to maintain liveness for long-running workflows or updates, and their associated timeouts can be configured using the generated options helpers. For an example of xns integration, see the [example/external](./example/external/external.go) package.
648650
649651
## Documentation
650652

0 commit comments

Comments
 (0)