From 431bc1feff920df8145d0ab8f626cb96c4469b6a Mon Sep 17 00:00:00 2001 From: Josh Creek Date: Wed, 25 Aug 2021 23:48:01 +0100 Subject: [PATCH] feat(*): Update readme for SubstringBetween --- Creek.HelpfulExtensions/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/Creek.HelpfulExtensions/README.md b/Creek.HelpfulExtensions/README.md index 2235113..8c1f2bc 100644 --- a/Creek.HelpfulExtensions/README.md +++ b/Creek.HelpfulExtensions/README.md @@ -1,2 +1,22 @@ # Creek.HelpfulExtensions A package containing helpful extensions to either save time or cognitive load. + +## String Extensions + +### SubstringBetween + +This method allows you to return a substring from the first occurrence of the start string to the end string. Normally with `Substring` you have to put the start string and the length from there, but with this you can more naturally select between two strings, with the option to use either the first or last match for the end string. + +For example, this code will result in the string `"fishman"`. + +```csharp +string s = "bigfishmandogcatdoghat"; +s = s.SubstringBetween("fish", "dog"); +``` + +Whereas, this will result in the string `"fishmandogcat"` as the boolean passed in confirms you wish to use the last match of the end string. + +```csharp +string s = "bigfishmandogcatdoghat"; +s = s.SubstringBetween("fish", "dog", true); +```