Skip to content

Commit d59adc4

Browse files
Prepare README for public preview release (#56)
Co-authored-by: Michael Peng <[email protected]>
1 parent 89b6ce9 commit d59adc4

File tree

1 file changed

+27
-12
lines changed

1 file changed

+27
-12
lines changed

README.md

Lines changed: 27 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,29 @@
1-
# Project
1+
# Durable Functions for PowerShell
22

3-
> This repo has been populated by an initial template to help get you started. Please
4-
> make sure to update the content to build a great experience for community-building.
3+
This repo hosts the standalone Durable Functions SDK for PowerShell. Compared to the Durable Functions SDK that comes built-in with the Azure Functions PowerShell worker, this standalone SDK contains performance enhancements, more features, and key bug fixes that would have required a breaking release. For more information on this release, please see [this article](TODO).
54

6-
As the maintainer of this project, please make a few updates:
5+
> The standalone Durable Functions SDK implementation is currently in **preview**. For production workloads, we recommend continuing to use the built-in Durable Functions SDK.
76
8-
- Improving this README.MD file to provide a great experience
9-
- Updating SUPPORT.MD with content about this project's support experience
10-
- Understanding the security reporting process in SECURITY.MD
11-
- Remove this section from the README
7+
⚡ Find us in the [PowerShell Gallery](https://www.powershellgallery.com/packages/AzureFunctions.PowerShell.Durable.SDK) ⚡.
8+
9+
10+
## About Durable Functions
11+
[Durable Functions](https://docs.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-overview) is an extension of [Azure Functions](https://docs.microsoft.com/en-us/azure/azure-functions/functions-overview) that lets you write stateful functions in a serverless compute environment. The extension lets you define stateful workflows by writing orchestrator functions and stateful entities by writing entity functions using the Azure Functions programming model. Behind the scenes, the extension manages state, checkpoints, and restarts for you, allowing you to focus on your business logic.
12+
13+
You can find more information at the following links:
14+
15+
* [Azure Functions overview](https://docs.microsoft.com/en-us/azure/azure-functions/functions-overview)
16+
* [Azure Functions PowerShell developers guide](https://learn.microsoft.com/en-us/azure/azure-functions/functions-reference-powershell)
17+
* [Durable Functions overview](https://docs.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-overview)
18+
* [Core concepts and features overview](https://docs.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-types-features-overview).
19+
20+
> Durable Functions expects certain programming constraints to be followed. Please read the documentation linked above for more information.
21+
22+
## Getting Started
23+
24+
Follow these instructions to get started with Durable Functions in PowerShell:
25+
26+
**🚀 [PowerShell Durable Functions quickstart](https://learn.microsoft.com/en-us/azure/azure-functions/durable/quickstart-powershell-vscode)**
1227

1328
## Contributing
1429

@@ -26,8 +41,8 @@ contact [[email protected]](mailto:[email protected]) with any additio
2641

2742
## Trademarks
2843

29-
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
30-
trademarks or logos is subject to and must follow
31-
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
44+
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
45+
trademarks or logos is subject to and must follow
46+
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general).
3247
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
33-
Any use of third-party trademarks or logos are subject to those third-party's policies.
48+
Any use of third-party trademarks or logos are subject to those third-party's policies.

0 commit comments

Comments
 (0)