From 4b900301a0599097d0a756344893f7630bda6feb Mon Sep 17 00:00:00 2001 From: xegineering Date: Wed, 2 Oct 2024 15:31:52 +0200 Subject: 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 --- README.md | 3 +++ 1 file changed, 3 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 1952d11..e5026e6 100644 --- a/README.md +++ b/README.md @@ -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 -- cgit v1.2.3-70-g09d2