From 644400797b642f5fae7d7426db34492ab8788e97 Mon Sep 17 00:00:00 2001 From: David Justo Date: Tue, 30 May 2023 08:57:02 -0700 Subject: [PATCH 1/2] prepare README --- README.md | 39 +++++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 5cd7cec..f25254e 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,29 @@ -# Project +# Durable Functions for PowerShell -> This repo has been populated by an initial template to help get you started. Please -> make sure to update the content to build a great experience for community-building. +This repo hosts the standalone Durable Functions SDK for PowerShell. Compared, to the Durable Functions SDK that comes built-in to 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). -As the maintainer of this project, please make a few updates: +> The standalone Durable Functions SDK implementation is currently in **preview**. For production workloads, we recommend continuing to use the built-in Durable Functions SDK. -- Improving this README.MD file to provide a great experience -- Updating SUPPORT.MD with content about this project's support experience -- Understanding the security reporting process in SECURITY.MD -- Remove this section from the README +⚡ Find us in the [PowerShell Gallery](https://www.powershellgallery.com/packages/AzureFunctions.PowerShell.Durable.SDK) ⚡. + + +## About Durable Functions + [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. + +You can find more information at the following links: + +* [Azure Functions overview](https://docs.microsoft.com/en-us/azure/azure-functions/functions-overview) +* [Azure Functions PowerShell developers guide](https://learn.microsoft.com/en-us/azure/azure-functions/functions-reference-powershell) +* [Durable Functions overview](https://docs.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-overview) +* [Core concepts and features overview](https://docs.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-types-features-overview). + +> Durable Functions expects certain programming constraints to be followed. Please read the documentation linked above for more information. + +## Getting Started + +Follow these instructions to get started with Durable Functions in PowerShell: + +**🚀 [PowerShell Durable Functions quickstart](https://learn.microsoft.com/en-us/azure/azure-functions/durable/quickstart-powershell-vscode)** ## Contributing @@ -26,8 +41,8 @@ contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additio ## Trademarks -This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft -trademarks or logos is subject to and must follow -[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). +This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft +trademarks or logos is subject to and must follow +[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. -Any use of third-party trademarks or logos are subject to those third-party's policies. +Any use of third-party trademarks or logos are subject to those third-party's policies. \ No newline at end of file From aeb87b590eff78e3bf14ea995ecc541a9a299b1d Mon Sep 17 00:00:00 2001 From: David Justo Date: Tue, 30 May 2023 10:13:11 -0700 Subject: [PATCH 2/2] Update README.md Co-authored-by: Michael Peng --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f25254e..51a0a37 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Durable Functions for PowerShell -This repo hosts the standalone Durable Functions SDK for PowerShell. Compared, to the Durable Functions SDK that comes built-in to 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). +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). > The standalone Durable Functions SDK implementation is currently in **preview**. For production workloads, we recommend continuing to use the built-in Durable Functions SDK.