franz-go
franz-go copied to clipboard
Git Tags/Versions Not Quite Right?
Edit: Ignore, can delete. Turns out we'd were go getting the root package which is't a go package root.
Would an import statement in the getting started example help prevent this confusion?
I think an "install" block might be useful, since there are many modules in this one repo which is pretty uncommon.
lmk if the recently pushed install block clears things up or not :)
I suspect it'd be far more informative/better to add the import
directives to the examples showing that the package is not rooted at the base of the repo - which is essentially the de-facto standard for most mainstream packages. Obviously this can't be readily changed retrospectively, so the import as @godwhoa said above would illustrate the point.
Otherwise people will be trying to figure out where kgo comes from (and as in my case, referencing the root and wondering why go get fails silently).
I've expanded the wording a little bit. However, given the many examples, and the readme, and how other projects do it, I'm not sure how much more it makes sense to continue adding to the readme.