Skip to content

Commit 7757173

Browse files
committed
Remove TChannel Proxy references from README
1 parent be8d259 commit 7757173

File tree

2 files changed

+4
-27
lines changed

2 files changed

+4
-27
lines changed

README.md

+2-25
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ To find more about Temporal please visit <https://temporal.io/>.
99

1010
## Getting Started
1111

12-
*NOTE: Make sure you have both Temporal and TChannel Proxy up and running. Head over to
13-
[this section](#installing-dependencies) for installation instructions.*
14-
1512
Clone this repository:
1613

1714
```sh
@@ -21,7 +18,7 @@ Clone this repository:
2118
Include this gem to your `Gemfile`:
2219

2320
```ruby
24-
gem 'temporal-ruby', path: 'path/to/a/cloned/temporal-ruby/'
21+
gem 'temporal-ruby', github: 'coinbase/temporal-ruby'
2522
```
2623

2724
Define an activity:
@@ -55,7 +52,7 @@ Configure your Temporal connection:
5552
```ruby
5653
Temporal.configure do |config|
5754
config.host = 'localhost'
58-
config.port = 6666 # this should point to the tchannel proxy
55+
config.port = 7233
5956
config.domain = 'ruby-samples'
6057
config.task_list = 'hello-world'
6158
end
@@ -97,11 +94,6 @@ available, make sure to check them out.
9794

9895
## Installing dependencies
9996

100-
In order to run your Ruby workers you need to have the Temporal service and the TChannel Proxy
101-
running. Below are the instructions on setting these up:
102-
103-
### Temporal
104-
10597
Temporal service handles all the persistence, fault tolerance and coordination of your workflows and
10698
activities. To set it up locally, download and boot the Docker Compose file from the official repo:
10799

@@ -111,21 +103,6 @@ activities. To set it up locally, download and boot the Docker Compose file from
111103
> docker-compose up
112104
```
113105

114-
### TChannel Proxy
115-
116-
Right now the Temporal service only communicates with the workers using Thrift over TChannel.
117-
Unfortunately there isn't a working TChannel protocol implementation for Ruby, so in order to
118-
connect to the Temporal service a simple proxy was created. You can run it using:
119-
120-
```sh
121-
> cd proxy
122-
123-
> bin/proxy
124-
```
125-
126-
The code and detailed instructions can be found [here](proxy/).
127-
128-
129106
## Workflows
130107

131108
A workflow is defined using pure Ruby code, however it should contain only a high-level

examples/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
This directory contains examples demonstraiting different features or this library and Temporal.
44

5-
To try these out you need to have Temporal and TChannel Proxy running ([setup instructions](https://github.com/coinbase/temporal-ruby#installing-dependencies)).
5+
To try these out you need to have a running Temporal service ([setup instructions](https://github.com/coinbase/temporal-ruby#installing-dependencies)).
66

77
Install all the gem dependencies by running:
88

99
```sh
1010
> bundle install
1111
```
1212

13-
Modify the `init.rb` file to point to your TChannel Proxy.
13+
Modify the `init.rb` file to point to your Temporal cluster.
1414

1515
Start a worker process:
1616

0 commit comments

Comments
 (0)