Skip to content

Commit

Permalink
docs: udpate documentation for the v1.0.0 release (#69)
Browse files Browse the repository at this point in the history
  • Loading branch information
hedhyw authored Oct 12, 2024
1 parent fb0caf0 commit 3bbc203
Showing 1 changed file with 1 addition and 9 deletions.
10 changes: 1 addition & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,15 +115,7 @@ re := rex.New(

5. **Is it stable?**

It is `0.X.Y` version, but there are some backward compatibility guarantees:
- `rex.Chars` helpers can change output to an alternative synonym.
- `rex.Common` helpers can be deprecated, but not removed.
- `rex.Group` some methods can be deprecated.
- `rex.Helper` can be changed with breaking changes due to specification complexities.
- The test coverage should be `~100%` without covering [test helpers](internal/test/test.go) and [cmd](cmd).
- Any breaking change will be prevented as much as possible.

_All of the above may not be respected when upgrading the major version._
Yes, starting with version v1.0.0.

6. **I have another question. I found an issue. I have a feature request. I want to contribute.**

Expand Down

0 comments on commit 3bbc203

Please sign in to comment.