Brief intro

Author: dbarkol

README.md

@@ -1,2 +1,37 @@
-# event-driven-architecture
-Event Driven Architecture demos
+# Event-Driven Architecture Demos
+
+## About this repository
+
+This GitHub repository provides a collection of event-driven architecture demos. It is designed to provide examples on how to implement and design real-world solutions that are event-driven, built on [Azure](https://azure.microsoft.com/) and make use of best-practices and [design patterns](https://learn.microsoft.com//azure/architecture/patterns/).
+
+## Design Patterns
+
+Design patterns that are showcased in this include:
+
+* [Claim-Check](https://learn.microsoft.com/azure/architecture/patterns/claim-check)
+* [Transactional Outbox](https://learn.microsoft.com/azure/architecture/best-practices/transactional-outbox-cosmos)
+* [Saga](https://learn.microsoft.com/azure/architecture/reference-architectures/saga/saga) with distributed transactions
+
+Services used:
+
+* [Service Bus](https://learn.microsoft.com/azure/service-bus-messaging/)
+* [Event Grid](https://learn.microsoft.com/azure/event-grid/)
+* [Event Hubs](https://learn.microsoft.com/azure/event-hubs/)
+* [Stream Analytics](https://learn.microsoft.com/azure/stream-analytics/)
+* [Cosmos DB](https://learn.microsoft.com/azure/cosmos-db/)
+* [Azure Functions](https://learn.microsoft.com/azure/azure-functions/)
+* [Storage](https://learn.microsoft.com/azure/storage/)
+
+## Contributing
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [[email protected]](mailto:[email protected]) with any additional questions or comments.