-
Notifications
You must be signed in to change notification settings - Fork 66
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.
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
Add usage info to README #238
base: master
Are you sure you want to change the base?
Conversation
|
||
## How to use | ||
Proto files describing our gRPC API. Implemented by [Temporal Server](https://github.com/temporalio/temporal) and used by the [SDKs](https://docs.temporal.io/temporal#temporal-sdk) (both Clients and Workers). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe "Temporal gRPC API"?
And not "describing", but "defining". I wish they described a little more.
|
||
### With code | ||
|
||
Usually you interact with the API via high-level SDK methods like `startWorkflow()`. However, Clients also expose the underlying gRPC services, like: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe we should use "Service Clients"? "Clients" is a bit of a general term.
|
||
Usually you interact with the API via high-level SDK methods like `startWorkflow()`. However, Clients also expose the underlying gRPC services, like: | ||
|
||
- [`Client.connection.workflowService`](https://typescript.temporal.io/api/classes/client.connection/#workflowservice) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add links to the corresponding way to get a raw grpc client in other languages?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, only minor talking points.
README.md
Outdated
|
||
### Via REST | ||
|
||
See [`temporalio/ui-server`](https://github.com/temporalio/ui-server) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure we want to promote this as an API server unless it's offering compatibility guarantees. Instead we should be putting HTTP annotations on these protos.
|
||
### With code | ||
|
||
Usually you interact with the API via high-level SDK methods like `startWorkflow()`. However, Clients also expose the underlying gRPC services, like: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's reasonable to either: 1) put every SDK's approach to raw gRPC invocation in here, or 2) put every SDK's approach to raw gRPC invocation somewhere and link to it from here.
|
||
Install as git submodule to the project. | ||
- [Use the API](#use-the-api) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this TOC expected to be manually maintained? In GH, the TOC is already available at the top-left of the README.
No description provided.