Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Drop table of contents in README.md #1541

Merged
merged 1 commit into from
Sep 4, 2023
Merged

Drop table of contents in README.md #1541

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 0 additions & 75 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,81 +44,6 @@ We are a member of the [.NET Foundation](https://www.dotnetfoundation.org/about)
| Polly.RateLimiting | [![NuGet](https://buildstats.info/nuget/Polly.RateLimiting?includePreReleases=true)](https://www.nuget.org/packages/Polly.RateLimiting/ "Download Polly.RateLimiting from NuGet.org") |
| Polly.Testing | [![NuGet](https://buildstats.info/nuget/Polly.Testing?includePreReleases=true)](https://www.nuget.org/packages/Polly.Testing/ "Download Polly.Testing from NuGet.org") |

---

<!-- This TOC can be maintained using VS Code's 'Markdown All in One' extension -->
<!-- Just set the Toc: Levels setting to '2..4', open the command palette, -->
<!-- and run 'Markdown All in One: Update Table of Contents' -->
- [Polly](#polly)
- [NuGet Packages](#nuget-packages)
- [Polly v7](#polly-v7)
- [Polly v8 Pre-releases](#polly-v8-pre-releases)
- [Get Started](#get-started)
- [Installing via the .NET SDK](#installing-via-the-net-sdk)
- [Supported targets](#supported-targets)
- [Using Polly with HttpClient factory from ASP.NET Core 2.1](#using-polly-with-httpclient-factory-from-aspnet-core-21)
- [Role of the readme and the wiki](#role-of-the-readme-and-the-wiki)
- [Release notes](#release-notes)
- [Resilience policies](#resilience-policies)
- [Usage – fault-handling, reactive policies](#usage--fault-handling-reactive-policies)
- [Step 1 : Specify the exceptions/faults you want the policy to handle](#step-1--specify-the-exceptionsfaults-you-want-the-policy-to-handle)
- [Step 1b: (optionally) Specify return results you want to handle](#step-1b-optionally-specify-return-results-you-want-to-handle)
- [Step 2 : Specify how the policy should handle those faults](#step-2--specify-how-the-policy-should-handle-those-faults)
- [Retry](#retry)
- [Retry forever (until succeeds)](#retry-forever-until-succeeds)
- [Wait and retry](#wait-and-retry)
- [Wait and retry forever (until succeeds)](#wait-and-retry-forever-until-succeeds)
- [Circuit Breaker](#circuit-breaker)
- [Advanced Circuit Breaker](#advanced-circuit-breaker)
- [Fallback](#fallback)
- [Step 3 : Execute code through the policy](#step-3--execute-code-through-the-policy)
- [Richer policy consumption patterns](#richer-policy-consumption-patterns)
- [Usage – proactive policies](#usage--proactive-policies)
- [Step 1 : Configure](#step-1--configure)
- [Optimistic timeout](#optimistic-timeout)
- [Pessimistic timeout](#pessimistic-timeout)
- [Bulkhead](#bulkhead)
- [Rate-Limit](#rate-limit)
- [Cache](#cache)
- [PolicyWrap](#policywrap)
- [NoOp](#noop)
- [Step 2 : Execute the policy](#step-2--execute-the-policy)
- [Usage – results and exceptions](#usage--results-and-exceptions)
- [Getting execution results as a PolicyResult](#getting-execution-results-as-a-policyresult)
- [Getting execution results and return values with a HttpResponseMessage](#getting-execution-results-and-return-values-with-a-httpresponsemessage)
- [Getting execution results and return values with a Policy\<TResult\>](#getting-execution-results-and-return-values-with-a-policytresult)
- [Getting strongly-typed results with ExecuteAndCapture\<TResult\>()](#getting-strongly-typed-results-with-executeandcapturetresult)
- [State-change delegates on Policy\<TResult\> policies](#state-change-delegates-on-policytresult-policies)
- [BrokenCircuitException\<TResult\>](#brokencircuitexceptiontresult)
- [Policy Keys and Context data](#policy-keys-and-context-data)
- [PolicyRegistry](#policyregistry)
- [Asynchronous Support](#asynchronous-support)
- [SynchronizationContext](#synchronizationcontext)
- [Cancellation support](#cancellation-support)
- [Thread safety](#thread-safety)
- [Interfaces](#interfaces)
- [Execution interfaces: `ISyncPolicy` etc](#execution-interfaces-isyncpolicy-etc)
- [Policy-kind interfaces: `ICircuitBreakerPolicy` etc](#policy-kind-interfaces-icircuitbreakerpolicy-etc)
- [Custom policies](#custom-policies)
- [Chaos engineering with Simmy](#chaos-engineering-with-simmy)
- [Polly-Contrib](#polly-contrib)
- [Available via Polly-Contrib](#available-via-polly-contrib)
- [3rd Party Libraries and Contributions](#3rd-party-libraries-and-contributions)
- [Acknowledgements](#acknowledgements)
- [Sample Projects](#sample-projects)
- [Instructions for Contributing](#instructions-for-contributing)
- [License](#license)
- [Blogs, podcasts, courses, e-books, architecture samples and videos around Polly](#blogs-podcasts-courses-e-books-architecture-samples-and-videos-around-polly)
- [Blog posts](#blog-posts)
- [Podcasts](#podcasts)
- [PluralSight course](#pluralsight-course)
- [Sample microservices architecture and e-book](#sample-microservices-architecture-and-e-book)
- [Sample microservices architecture](#sample-microservices-architecture)
- [e-book](#e-book)
- [Videos](#videos)

---

## Get Started

### Installing via the .NET SDK
Expand Down