Skip to content

Commit 47ec529

Browse files
committed
Set readme badges to main branch
1 parent 1988b74 commit 47ec529

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44

55
# dispatch-py
66

7-
[![Docs](https://github.com/dispatchrun/dispatch-py/actions/workflows/docs.yml/badge.svg?branch=)](https://github.com/dispatchrun/dispatch-py/actions/workflows/docs.yml)
8-
[![PyPI](https://github.com/dispatchrun/dispatch-py/actions/workflows/pypi.yml/badge.svg?branch=)](https://github.com/dispatchrun/dispatch-py/actions/workflows/pypi.yml)
9-
[![Test](https://github.com/dispatchrun/dispatch-py/actions/workflows/test.yml/badge.svg?branch=)](https://github.com/dispatchrun/dispatch-py/actions/workflows/test.yml)
7+
[![Docs](https://github.com/dispatchrun/dispatch-py/actions/workflows/docs.yml/badge.svg?branch=main)](https://github.com/dispatchrun/dispatch-py/actions/workflows/docs.yml)
8+
[![PyPI](https://github.com/dispatchrun/dispatch-py/actions/workflows/pypi.yml/badge.svg?branch=main)](https://github.com/dispatchrun/dispatch-py/actions/workflows/pypi.yml)
9+
[![Test](https://github.com/dispatchrun/dispatch-py/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/dispatchrun/dispatch-py/actions/workflows/test.yml)
1010
[![PyPI version](https://badge.fury.io/py/dispatch-py.svg)](https://badge.fury.io/py/dispatch-py)
1111
[![Reference](https://img.shields.io/badge/API-Reference-lightblue.svg)](https://python.dispatch.run/main/reference/dispatch/)
1212

1313
Python package to develop applications with the Dispatch platform.
1414

1515
[fastapi]: https://fastapi.tiangolo.com/tutorial/first-steps/
16-
[pypi]: https://pypi.org/project/dispatch-py/
17-
[signup]: https://console.dispatch.run/
16+
[pypi]: https://pypi.org/project/dispatch-py/
17+
[signup]: https://console.dispatch.run/
1818

1919
- [What is Dispatch?](#what-is-dispatch)
2020
- [Installation](#installation)
@@ -52,14 +52,15 @@ brew install dispatch
5252
Alternatively, you can download the latest `dispatch` binary from the
5353
[Releases](https://github.com/dispatchrun/dispatch/releases) page.
5454

55-
*Note that this step is optional, applications that use Dispatch can run without
55+
_Note that this step is optional, applications that use Dispatch can run without
5656
the CLI, passing configuration through environment variables or directly in the
5757
code. However, the CLI automates the onboarding flow and simplifies the
58-
configuration, so we recommend starting with it.*
58+
configuration, so we recommend starting with it._
5959

6060
### Installing the Dispatch SDK
6161

6262
The Python package is published on [PyPI][pypi] as **dispatch-py**, to install:
63+
6364
```console
6465
pip install dispatch-py
6566
```
@@ -93,19 +94,21 @@ interesting work, but it's a good start to get a sense of how to use Dispatch.
9394

9495
The simplest way to run a Dispatch application is to use the Dispatch CLI, first
9596
we need to login:
97+
9698
```console
9799
dispatch login
98100
```
99101

100102
Then we are ready to run the example program we wrote above:
103+
101104
```console
102105
dispatch run -- python3 main.py
103106
```
104107

105108
### Writing Transactional Applications with Dispatch
106109

107110
The `@dispatch.function` decorator can also be applied to Python coroutines
108-
(a.k.a. *async* functions), in which case each `await` point becomes a
111+
(a.k.a. _async_ functions), in which case each `await` point becomes a
109112
durability step in the execution. If the awaited operation fails, it is
110113
automatically retried, and the parent function is paused until the result are
111114
available or a permanent error is raised.
@@ -153,10 +156,10 @@ async def transform(msg):
153156
...
154157
```
155158

156-
Dispatch converts Python coroutines to *Distributed Coroutines*, which can be
159+
Dispatch converts Python coroutines to _Distributed Coroutines_, which can be
157160
suspended and resumed on any instance of a service across a fleet. For a deep
158161
dive on these concepts, read our blog post on
159-
[*Distributed Coroutines with a Native Python Extension and Dispatch*](https://dispatch.run/blog/distributed-coroutines-in-python).
162+
[_Distributed Coroutines with a Native Python Extension and Dispatch_](https://dispatch.run/blog/distributed-coroutines-in-python).
160163

161164
### Integration with FastAPI
162165

0 commit comments

Comments
 (0)