Refresh README (#7584)

## What changed?
<!-- Describe what has changed in this PR -->

A refresh of our README.

| Before | After |
|--------|--------|
| <img width="919" alt="Screenshot 2025-04-07 at 2 48 07 PM"
src="https://github.com/user-attachments/assets/92485c3d-770a-493d-86a3-ca2331d19a55"
/> | <img width="929" alt="Screenshot 2025-04-07 at 2 49 21 PM"
src="https://github.com/user-attachments/assets/f0dc4b4f-4a6f-4037-b789-a0fa027901b6"
/> |
 
[See it
here](https://github.com/stephanos/temporal/tree/readme-refresh).

## Why?
<!-- Tell your future self why have you made these changes -->

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?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->

## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->

## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->

## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
This commit is contained in:
Stephan Behnke
2025-04-07 18:42:37 -07:00
committed by GitHub
parent 98794def89
commit ae71eedd6b

View File

@@ -1,12 +1,24 @@
<div class="title-block" style="text-align: center;" align="center">
# Temporal—durable execution platform
<p><img title="temporal logo" src="https://avatars.githubusercontent.com/u/56493103?s=320" width="320" height="320"></p>
[![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) &nbsp;&nbsp;&bull;&nbsp;&nbsp;**
**[Getting Started](#getting-started) &nbsp;&nbsp;&bull;&nbsp;&nbsp;**
**[Contributing](#contributing) &nbsp;&nbsp;&bull;&nbsp;&nbsp;**
**[Temporal Docs](https://docs.temporal.io/) &nbsp;&nbsp;&bull;&nbsp;&nbsp;**
**[Temporal 101](https://learn.temporal.io/courses/temporal_101/)**
# Temporal
</div>
## 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