onyx_online/vbantxt
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vbantxt.git synced 2024-11-21 17:30:49 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add note about functional options to README

Browse Source
This commit is contained in:
onyx-and-iris 2024-11-03 15:54:34 +00:00
parent 92d5d96967
commit 7a844e3624
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CHANGELOG.md
View File

@ -17,6 +17,7 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
- `config` flag (shorthand `C`), you may now specify a custom config directory. It defaults to `home directory / .config / vbantxt_cli /`. - `config` flag (shorthand `C`), you may now specify a custom config directory. It defaults to `home directory / .config / vbantxt_cli /`.
- please note, the default directory has changed from v0.1.0 - please note, the default directory has changed from v0.1.0
- Functional options `WithRateLimit` and `WithBPSOpt` and `WithChannel` added. Use them to configure the vbantxt client. See the [included vbantxt cli][vbantxt-cli] for an example of usage.
### Changed ### Changed
@ -41,3 +42,5 @@ Before any major/minor/patch bump all unit tests will be run to verify they pass
- Initial release, package implements VBAN PROTOCOL TXT with a basic CLI for configuring options. - Initial release, package implements VBAN PROTOCOL TXT with a basic CLI for configuring options.
- Ability to load configuration settings from a config.toml. - Ability to load configuration settings from a config.toml.
[vbantxt-cli]: https://github.com/onyx-and-iris/vbantxt/blob/main/cmd/vbantxt/main.go