Add godoc badge in readme #20
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add godoc badge
|
Hey Lucian! This repo is autogenerated from the main repo every release, and we already have this badge at the client readme: https://github.com/tigerbeetle/tigerbeetle/tree/main/src/clients/go Anyway, adding more information here would be a nice touch, but this message is generated by the CI (source code here), and we don't want to pollute it with client-specific URLs. Maybe if we gave more emphasis to the sentence that links to the main repo (e.g. "Please see https://github.com/tigerbeetle/tigerbeetle/tree/main/src/clients/go for documentation and contributions.") it would be more informative to the users, but much less intrusive. |
|
A double line ending between the two sentences will help |
|
Closed by tigerbeetle/tigerbeetle#1844 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add godoc badge
Example: