Document usage in Golang project #381

Open
opened 2026-01-29 20:43:01 +00:00 by claunia · 3 comments
Owner

Originally created by @micheartin on GitHub (Apr 20, 2021).

The current README.md explains how to use brotli in different programming languages except for Go. Therefore, many Go developers fail to use it, see:

Please document somewhere (in README.md for example) how to use cbrotli in a Golang project:

  • the C implementation must be compiled before
  • how to import the library in a Go source code
Originally created by @micheartin on GitHub (Apr 20, 2021). The current README.md explains how to use brotli in different programming languages except for Go. Therefore, many Go developers fail to use it, see: - https://github.com/google/brotli/issues/890 - https://stackoverflow.com/q/47233208 Please document somewhere (in README.md for example) how to use `cbrotli` in a Golang project: - the C implementation must be compiled before - how to import the library in a Go source code
Author
Owner

@eustas commented on GitHub (Aug 13, 2021):

Will be partially resolved by #915

@eustas commented on GitHub (Aug 13, 2021): Will be partially resolved by #915
Author
Owner

@micheartin commented on GitHub (Sep 8, 2021):

To simplify the Go developer life, the documentation may (should) also present the alternative https://github.com/andybalholm/brotli

@micheartin commented on GitHub (Sep 8, 2021): To simplify the Go developer life, the documentation may (should) also present the alternative https://github.com/andybalholm/brotli
Author
Owner

@eustas commented on GitHub (Sep 8, 2021):

I've asked the author of that repo if transpiled brotli could be adopted, and they have given the permission.
Still there is work to be done to make that actually happen.

@eustas commented on GitHub (Sep 8, 2021): I've asked the author of that repo if transpiled brotli could be adopted, and they have given the permission. Still there is work to be done to make that actually happen.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/brotli#381