diff --git a/README.md b/README.md index 303506bd85..5ffb2e5a0b 100644 --- a/README.md +++ b/README.md @@ -68,3 +68,19 @@ passed in order to encourage readable expressions, so `[0-9]+` is equivalent to `Sx` is enabled by default in order to encourage use of whitespace for better readability. + +## Usage + +### `proc match(str: string, pattern: Regex, start = 0, endpos = -1): RegexMatch` +Tries to match the pattern, starting at start. This means that +`"foo".match(re"f") == true`, but `"foo".match(re"o") == false`. + +