From ae71eedd6bbe99f8cc8b835cb1de1a54565ed5a1 Mon Sep 17 00:00:00 2001 From: Stephan Behnke Date: Mon, 7 Apr 2025 18:42:37 -0700 Subject: [PATCH] Refresh README (#7584) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## What changed? A refresh of our README. | Before | After | |--------|--------| | Screenshot 2025-04-07 at 2 48 07 PM | Screenshot 2025-04-07 at 2 49 21 PM | [See it here](https://github.com/stephanos/temporal/tree/readme-refresh). ## Why? I saw the https://github.com/jj-vcs/jj README and felt our README could learn a thing or two from that one. ## How did you test it? ## Potential risks ## Documentation ## Is hotfix candidate? --- README.md | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index bc5f7efe40..d89e30ebb9 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,24 @@ +
+ +# Temporal—durable execution platform + +

+ [![GitHub Release](https://img.shields.io/github/v/release/temporalio/temporal)](https://github.com/temporalio/temporal/releases/latest) +[![GitHub License](https://img.shields.io/github/license/temporalio/temporal)](https://github.com/temporalio/temporal/blob/main/LICENSE) [![Code Coverage](https://img.shields.io/badge/codecov-report-blue)](https://app.codecov.io/gh/temporalio/temporal) [![Community](https://img.shields.io/static/v1?label=community&message=get%20help&color=informational)](https://community.temporal.io) -[![Go Report Card][go-report-image]][go-report-url] +[![Go Report Card](https://goreportcard.com/badge/github.com/temporalio/temporal)](https://goreportcard.com/report/github.com/temporalio/temporal) -[go-report-image]: https://goreportcard.com/badge/github.com/temporalio/temporal -[go-report-url]: https://goreportcard.com/report/github.com/temporalio/temporal +**[Introduction](#introduction)   •  ** +**[Getting Started](#getting-started)   •  ** +**[Contributing](#contributing)   •  ** +**[Temporal Docs](https://docs.temporal.io/)   •  ** +**[Temporal 101](https://learn.temporal.io/courses/temporal_101/)** -# Temporal +
+ +## Introduction Temporal is a durable execution platform that enables developers to build scalable applications without sacrificing productivity or reliability. The Temporal server executes units of application logic called Workflows in a resilient manner that automatically handles intermittent failures, and retries failed operations. @@ -16,12 +28,6 @@ It is developed by [Temporal Technologies](https://temporal.io/), a startup by t [![image](https://github.com/temporalio/temporal/assets/251288/693d18b5-01de-4a3b-b47b-96347b84f610)](https://youtu.be/wIpz4ioK0gI 'Getting to know Temporal') -Learn more: - -- [Courses](https://learn.temporal.io/courses/temporal_101/) -- [Docs](https://docs.temporal.io) -- Internal architecture: [docs/](./docs/architecture/README.md) - ## Getting Started ### Download and Start Temporal Server Locally