Update README with getting started instructions

cgillum commented 2 years ago

The README.md for this repo needs to be updated with getting started instructions. For now, let's focus on getting started for Azure Functions since the sidecar model isn't officially supported yet. A few things we'll need to include:

A link to the Durable Functions overview with a language tab set to java: https://docs.microsoft.com/en-us/azure/azure-functions/durable/durable-functions-overview?tabs=java (the content isn't there yet, but it will be)
Maven package information
JDK requirements (Java 8? Java 11? Both?)
Pointer to the quick start, once we know what the URL will be (can start out with a placeholder)
Step-by-step guide for getting started with the sample
Dev container instructions

The exact content can be flexible, but ideally advanced folks can use this information to get started without necessarily needing to refer to the quick start.

davidmrdavid commented 2 years ago

I'm realizing that, without the package and the corresponding bundles release being out, writing most of this requires a lot of assumptions. I'll hold off on writing this until those components land.

Also ok with folks taking over this item if they feel confident on it.

cgillum commented 1 year ago

These getting started instructions are here: https://github.com/microsoft/durabletask-java/tree/main/azurefunctions#azure-durable-functions-setup-for-java.

We also have an official quick-start guide here: https://docs.microsoft.com/en-us/azure/azure-functions/durable/quickstart-java

microsoft / durabletask-java

Update README with getting started instructions #61