docs: cleanup readme #322
Merged
docs: cleanup readme #322
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
Signed-off-by: Carlos Alexandro Becker <[email protected]>
|
examples are already on main, but still not showing up in pkg.go.dev |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #322 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 498 498
=========================================
Hits 498 498 ☔ View full report in Codecov by Sentry. |
BorzdeG
pushed a commit
to BorzdeG/env
that referenced
this pull request
Aug 24, 2024
* docs: cleanup readme Signed-off-by: Carlos Alexandro Becker <[email protected]> * docs: more improvements --------- Signed-off-by: Carlos Alexandro Becker <[email protected]>
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.
I moved all the examples to
example_test.go- which should show up in pkg.go.dev.Some examples in the readme were incorrect, some features were not documented, that kind of thing.
This way we have testable examples... hopefully that's better? wdyt?