Skip to content

Commit 56de4de

Browse files
authored
Added more context to the README sections
Added context to the Quick Start along with links to the reference material at the top of the README Added context to the Usage section Added a separator between Quick Start and Usage, as well as adjusting the headers to specifically call out the different sections as physically and logically different.
1 parent 7236159 commit 56de4de

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,9 @@ execute asynchronous, long-running business logic in a scalable and resilient wa
1010
"Temporal Python SDK" is the framework for authoring workflows and activities using the Python programming language.
1111

1212
Also see:
13-
14-
* [Code Samples](https://github.com/temporalio/samples-python)
15-
* [API Documentation](https://python.temporal.io)
16-
* [Application Development Guide](https://docs.temporal.io/application-development?lang=python)
13+
* [Application Development Guide](https://docs.temporal.io/application-development?lang=python) - Once you've tried our [Quick Start](#quick-start), check out our guide on how to use Temporal in your Python Applications, including information around Temporal core concepts.
14+
* [Python Code Samples](https://github.com/temporalio/samples-python)
15+
* [API Documentation](https://python.temporal.io) - Complete Temporal Python SDK Package reference
1716

1817
In addition to features common across all Temporal SDKs, the Python SDK also has the following interesting features:
1918

@@ -107,9 +106,11 @@ The Python SDK is under development. There are no compatibility guarantees at th
107106

108107
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
109108

110-
## Quick Start
109+
# Quick Start
110+
111+
We will guide you through the Temporal basics to create a "hello, world!" script on your machine. It is not intended as one of the ways to use Temporal, but in reality it is very simplified and decidedly not "the only way" to use Temporal. For more information, check out the docs references in "Next Steps" below the quick start.
111112

112-
### Installation
113+
## Installation
113114

114115
Install the `temporalio` package from [PyPI](https://pypi.org/project/temporalio).
115116

@@ -124,7 +125,7 @@ The SDK is now ready for use. To build from source, see "Building" near the end
124125

125126
**NOTE: This README is for the current branch and not necessarily what's released on `PyPI`.**
126127

127-
### Implementing a Workflow
128+
## Implementing a Workflow
128129

129130
Create the following script at `run_worker.py`:
130131

@@ -164,7 +165,7 @@ will run the worker:
164165

165166
python run_worker.py
166167

167-
### Running a Workflow
168+
## Running a Workflow
168169

169170
Create the following script at `run_workflow.py`:
170171

@@ -196,7 +197,19 @@ The output will be:
196197

197198
Result: Hello, my-name!
198199

199-
## Usage
200+
## Next Steps
201+
Temporal can be implemented in your code in many different ways, to suit your applicaiton's needs. The links below will give you much more information about how Temporal works with Python:
202+
203+
* [Code Samples](https://github.com/temporalio/samples-python) - if you want to start with some code, we have provided somepre-built samples
204+
* [Application Development Guide](https://docs.temporal.io/application-development?lang=python) - Our Python specific Developer's Guide will give you much more information on how to build with Temporal in your Python applications than our SDK README ever could (or should).
205+
* [API Documentation](https://python.temporal.io) - full Temporal Python SDK package documentation
206+
207+
---
208+
209+
# Usage
210+
211+
From here, you will find reference documentation about specific pieces of the Temporal Python SDK that were built around Temporal concepts.
212+
*This section is not intended as a how-to guide* -- For more how-to oriented information, check out the links in the [Next Steps](#next-steps) section above.
200213

201214
### Client
202215

0 commit comments

Comments
 (0)