Skip to content

Commit 764b9e4

Browse files
authored
Update readme (#861)
* Update readme * Fix casing * Add a better video still * Address feedback * Update statement about samples * Recommit video.png with LFS settings. * Cut a sentence to make intro more concise
1 parent b827869 commit 764b9e4

File tree

2 files changed

+42
-13
lines changed

2 files changed

+42
-13
lines changed

README.md

Lines changed: 39 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,65 @@
1-
# Temporal
21
[![Build status](https://badge.buildkite.com/fc0e676d7bee1a159916af52ebdb541708d4b9f88b8a980f6b.svg)](https://buildkite.com/temporal/temporal-server)
32
[![Coverage Status](https://coveralls.io/repos/github/temporalio/temporal/badge.svg?branch=master)](https://coveralls.io/github/temporalio/temporal?branch=master)
43
[![Discourse](https://img.shields.io/static/v1?label=Discourse&message=Get%20Help&color=informational)](https://community.temporal.io)
54

6-
Visit [docs.temporal.io](https://docs.temporal.io) to learn about Temporal.
5+
# Temporal
6+
7+
Temporal is a microservice orchestration platform which enables developers to build scalable applications without sacrificing productivity or reliability.
8+
Temporal server executes units of application logic, Workflows, in a resilient manner that automatically handles intermittent failures, and retries failed operations.
79

8-
This repo contains the source code of the Temporal server. To implement workflows, activities and worker use [Go SDK](https://github.com/temporalio/sdk-go) or [Java SDK](https://github.com/temporalio/sdk-java).
10+
Temporal is a mature technology, a fork of Uber's Cadence.
11+
Temporal is being developed by [Temporal Technologies](https://temporal.io/), a startup by the creators of Cadence.
912

10-
See Maxim's talk at [Data@Scale Conference](https://atscaleconference.com/videos/cadence-microservice-architecture-beyond-requestreply) for an architectural overview of Temporal.
13+
[![Temporal](video.png)](http://www.youtube.com/watch?v=f-18XztyN6c "Temporal")
14+
15+
Learn more about Temporal at [docs.temporal.io](https://docs.temporal.io).
1116

1217
## Getting Started
1318

14-
### Start the temporal-server locally
19+
### Download and Start Temporal Server Locally
20+
21+
Execute the following commands to start a pre-built image along with all the dependencies.
1522

16-
We highly recommend that you use [Temporal service docker](docker/README.md) to run the service.
23+
```bash
24+
$ curl -L https://github.com/temporalio/temporal/releases/latest/download/docker.tar.gz | tar -xz
25+
$ cd docker
26+
$ docker-compose up
27+
```
28+
29+
Refer to [Temporal service docker](docker/README.md) for more advanced options.
1730

1831
### Run the Samples
1932

20-
Try out the sample recipes for [Go](https://github.com/temporalio/samples-go) or [Java](https://github.com/temporalio/samples-java) to get started.
33+
Clone or download samples for [Go](https://github.com/temporalio/samples-go) or [Java](https://github.com/temporalio/samples-java) and run them with the local Temporal server.
34+
We have a number of [HelloWorld type scenarios](https://github.com/temporalio/samples-java#helloworld) available, as well as more advanced ones. Note that the sets of samples are currently different between Go and Java.
2135

2236
### Use CLI
2337

24-
Try out [Temporal command-line tool](tools/cli/README.md) to perform various tasks on Temporal
38+
Use [Temporal's command line tool](https://docs.temporal.io/docs/tctl) `tctl` to interact with the local Temporal server.
39+
40+
```bash
41+
$ alias tctl="docker run --rm temporalio/tctl:latest --address host.docker.internal:7233"
42+
$ tctl namespace list
43+
$ tctl workflow list
44+
```
45+
46+
### Use Temporal Web UI
2547

26-
### Use Temporal Web
48+
Try [Temporal Web UI](https://github.com/temporalio/web) by opening [http://localhost:8088](http://localhost:8088)for viewing your sample workflows executing on Temporal.
2749

28-
Try out [Temporal Web UI](https://github.com/temporalio/web) to view your workflows on Temporal.
29-
(This is already available at localhost:8088 if you run Temporal with docker compose)
50+
## Repository
51+
52+
This repository contains the source code of the Temporal server. To implement Workflows, Activities and Workers, use [Go SDK](https://github.com/temporalio/sdk-go) or [Java SDK](https://github.com/temporalio/sdk-java).
3053

3154
## Contributing
3255

3356
We'd love your help in making Temporal great. Please review our [contribution guide](CONTRIBUTING.md).
3457

35-
If you'd like to work on or propose a new feature, first peruse [feature requests](https://community.temporal.io/c/feature-requests/6) and our [proposals repo](https://github.com/temporalio/proposals) to discover existing active and accepted proposals. Feel free to join the Temporal [Slack channel](https://join.slack.com/t/temporalio/shared_invite/zt-c1e99p8g-beF7~ZZW2HP6gGStXD8Nuw) to start a discussion or check if a feature has already been discussed. Once you're sure the proposal is not covered elsewhere, please follow our [proposal instructions](https://github.com/temporalio/proposals#creating-a-new-proposal) or submit a [feature request](https://community.temporal.io/c/feature-requests/6).
58+
If you'd like to work on or propose a new feature, first peruse [feature requests](https://community.temporal.io/c/feature-requests/6) and our [proposals repo](https://github.com/temporalio/proposals) to discover existing active and accepted proposals.
59+
60+
Feel free to join the Temporal [Slack channel](https://join.slack.com/t/temporalio/shared_invite/zt-c1e99p8g-beF7~ZZW2HP6gGStXD8Nuw) to start a discussion or check if a feature has already been discussed.
61+
Once you're sure the proposal is not covered elsewhere, please follow our [proposal instructions](https://github.com/temporalio/proposals#creating-a-new-proposal) or submit a [feature request](https://community.temporal.io/c/feature-requests/6).
3662

3763
## License
3864

39-
MIT License, please see [LICENSE](https://github.com/temporalio/temporal/blob/master/LICENSE) for details.
65+
[MIT License](https://github.com/temporalio/temporal/blob/master/LICENSE)

video.png

Lines changed: 3 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)