Skip to content

Commit 071d406

Browse files
Simplify README.md
1 parent 36b4f30 commit 071d406

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ const currencyAmount = buildRegExp([
9191
]);
9292
```
9393

94-
See [API document](./docs/API.md).
94+
See [API doc](./docs/API.md) for more info.
9595

9696
### Regex Builders
9797

@@ -100,28 +100,29 @@ See [API document](./docs/API.md).
100100
| `buildRegExp(...)` | `/.../` | Create `RegExp` instance |
101101
| `buildRegExp(..., { ignoreCase: true })` | `/.../i` | Create `RegExp` instance with flags |
102102

103+
See [Regex Builder API doc](./docs/API.md#builder) for more info.
104+
103105
### Regex Constructs
104106

105107
| Construct | Regex Syntax | Notes |
106108
| ------------------- | ------------ | ------------------------------- |
107109
| `capture(...)` | `(...)` | Create a capture group |
108110
| `choiceOf(x, y, z)` | `x\|y\|z` | Match one of provided sequences |
109111

112+
See [Regex Constructs API doc](./docs/API.md#constructs) for more info.
113+
110114
### Quantifiers
111115

112116
| Quantifier | Regex Syntax | Description |
113117
| ----------------------------------------------- | ------------ | -------------------------------------------------------------- |
114118
| `zeroOrMore(x)` | `x*` | Zero or more occurence of a pattern |
115-
| `zeroOrMore(x, { greedy: false })` | `x*?` | Zero or more occurence of a pattern (non-greedy) |
116119
| `oneOrMore(x)` | `x+` | One or more occurence of a pattern |
117-
| `oneOrMore(x, { greedy: false })` | `x+?` | One or more occurence of a pattern (non-greedy) |
118120
| `optional(x)` | `x?` | Zero or one occurence of a pattern |
119-
| `optional(x, { greedy: false })` | `x??` | Zero or one occurence of a pattern (non-greedy) |
120121
| `repeat(x, n)` | `x{n}` | Pattern repeats exact number of times |
121122
| `repeat(x, { min: n, })` | `x{n,}` | Pattern repeats at least given number of times |
122-
| `repeat(x, { min: n, greedy: false })` | `x{n,}?` | Pattern repeats at least given number of times (non-greedy) |
123123
| `repeat(x, { min: n, max: n2 })` | `x{n1,n2}` | Pattern repeats between n1 and n2 number of times |
124-
| `repeat(x, { min: n, max: n2, greedy: false })` | `x{n1,n2}?` | Pattern repeats between n1 and n2 number of times (non-greedy) |
124+
125+
See [Quantifiers API doc](./docs/API.md#quantifiers) for more info.
125126

126127
### Character classes
127128

@@ -139,13 +140,17 @@ See [API document](./docs/API.md).
139140
| `charClass(...)` | `[...]` | Union of multiple character classes |
140141
| `inverted(...)` | `[^...]` | Negation of a given character class |
141142

143+
See [Character Classes API doc](./docs/API.md##character-classes) for more info.
144+
142145
### Anchors
143146

144147
| Anchor | Regex Syntax | Description |
145148
| --------------- | ------------ | ------------------------------------------------------------------------ |
146149
| `startOfString` | `^` | Match the start of the string (or the start of a line in multiline mode) |
147150
| `endOfString` | `$` | Match the end of the string (or the end of a line in multiline mode) |
148151

152+
See [Anchors API doc](./docs/API.md#anchors) for more info.
153+
149154
## Examples
150155

151156
See [Examples document](./docs/Examples.md).

0 commit comments

Comments
 (0)