From 948168c6ed6ce0bcf720971131b8a4344c1fe043 Mon Sep 17 00:00:00 2001 From: Pantazis Deligiannis Date: Tue, 22 Mar 2022 16:40:33 -0700 Subject: [PATCH] update readme (#319) --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index bd63d0cd..5bac91a6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Coyote logo](https://raw.githubusercontent.com/microsoft/coyote/main/docs/assets/images/logo_coyote.svg) +# `Coyote` [![NuGet](https://img.shields.io/nuget/v/Microsoft.Coyote.svg)](https://www.nuget.org/packages/Microsoft.Coyote/) [![Join the chat at https://gitter.im/Microsoft/coyote](https://badges.gitter.im/Microsoft/coyote.svg)](https://gitter.im/Microsoft/coyote?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -12,23 +12,27 @@ concurrency bugs. It gives you the ability to reliably *unit test the concurrency* and other sources of nondeterminism (such as message re-orderings, timeouts and failures) in your C# code. In the heart of Coyote is a -scheduler that takes control (via binary rewriting) of your program's execution during testing and -is able to systematically explore the concurrency and nondeterminism to find safety and liveness -bugs. The awesome thing is that once Coyote finds a bug it gives you the ability to fully -*reproduce* it as many times as you want, making debugging and fixing the issue much easier. +scheduler that takes control (via binary rewriting) of your program's concurrent execution during +testing and is able to _systematically explore_ the concurrency and nondeterminism to find bugs. The +awesome thing is that once Coyote finds a bug it gives you the ability to fully _reproduce_ it as +many times as you want, making debugging and fixing the issue much easier. -Coyote is used by several teams in [Azure](https://azure.microsoft.com/) to test their distributed +Coyote is used by many teams in [Azure](https://azure.microsoft.com/) to test their distributed systems and services, finding hundreds of concurrency-related bugs before they manifest in production. In the words of an Azure service architect: > Coyote found several issues early in the dev process, this sort of issues that would usually bleed > through into production and become very expensive to fix later. -See our [documentation](https://microsoft.github.io/coyote/) for more information about the project, -case studies, tutorials and reference documentation. - Coyote is made with :heart: by Microsoft Research. +## Get started + +Getting started with Coyote is easy! Check out +[https://microsoft.github.io/coyote](https://microsoft.github.io/coyote/) for tutorials, +documentation, how-tos, samples and more information about the project. Enjoy! + ## 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. @@ -38,6 +42,7 @@ CLA and decorate the PR appropriately (e.g., status check, comment). Simply foll provided by the bot. You will only need to do this once across all repositories using our CLA. ## Code of Conduct + 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