diff options
| author | xegineering <me@xegineering.eu> | 2024-10-02 15:31:52 +0200 |
|---|---|---|
| committer | xegineering <me@xegineering.eu> | 2024-10-02 15:31:52 +0200 |
| commit | 4b900301a0599097d0a756344893f7630bda6feb (patch) | |
| tree | e1a9d793cc6e092a3fb184018b66227f6cce218c /README.md | |
| parent | 3fc713ccfcc96738d981a97647a84a6cb6bbec04 (diff) | |
| download | soundbox-go-4b900301a0599097d0a756344893f7630bda6feb.tar soundbox-go-4b900301a0599097d0a756344893f7630bda6feb.tar.zst soundbox-go-4b900301a0599097d0a756344893f7630bda6feb.zip | |
Change Go module name from `soundbox-go` to `soundbox`
Go modules should be named with a single word if possible (see the
[standard libraray][1] as a reference example). Furthermore the module
name will be present in the code very often and thus length is a
critical point.
The repository and project should still be named `soundbox-go` to
distinguish it from the device repository [soundbox][2] and the
application repository [soundbox-app][3].
[1]: https://pkg.go.dev/std
[2]: https://cgit.xengineering.eu/soundbox
[3]: https://cgit.xengineering.eu/soundbox-app
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 3 |
1 files changed, 3 insertions, 0 deletions
@@ -2,4 +2,7 @@ soundbox-go is a Go library to interface with [soundbox][1] devices. +While the repository and project name is `soundbox-go` the Go module name is +only `soundbox` to make the resulting code more readable. + [1]: https://xengineering.eu/git/soundbox |