Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vodkaslime committed Sep 26, 2022
1 parent d61fb49 commit 71dac92
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

A simple golang customizable [wildcard](https://en.wikipedia.org/wiki/Wildcard_character) matcher. Golang has pretty well built regex functionalities, but it does not have basic wildcard matcher that works as nicely. Therefore this package serves the need to check whether a string matches a pattern in the rule of wildcard.

To keep simplicity, the matcher support only two rules:
To keep simplicity, the matcher supports only two rules:
- `"?"` for a single char.
- `"*"` for any number (including zero) of chars.

Charset like `"[A-Za-z]"` or SQL style wild cards like `%` are not supported.

## Usage
## usage

To import the package, `go get` the module.

Expand Down Expand Up @@ -37,7 +37,7 @@ func main() {
```

The default wildcard chars are `"?"` for single chars and `"*"` for multiple chars. To customize this rule, tune the `S` field or `M` field accordingly.
The default wildcard chars are `"?"` for single chars and `"*"` for multiple chars. To customize this rule, tune the `S` field and `M` field accordingly.

For example to use `"."` as single char wildcard symbol:

Expand Down

0 comments on commit 71dac92

Please sign in to comment.