docs: 📝 Improve repo readme #21
Merged
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
chadell
requested review from
progala and
Kircheneer
and removed request for
progala
Kircheneer
reviewed
Mar 13, 2023
README.md
Outdated
|
|
||
| ## Customization | ||
|
|
||
| This package only generates the bindings for the Nautobot Core application, and not for the rich [apps ecosystem](https://docs.nautobot.com/projects/core/en/stable/apps/) around it. It's likely that the bindings in this package are not 100% corresponding to your Nautobot environment, as you may have installed some public apps, or your own homegrown ones. |
There was a problem hiding this comment.
App(s) is always capitalized in the Nautobot docs, I think we should follow that example.
|
Apart from that looks good |
cmsirbu
reviewed
Mar 15, 2023
|
|
||
| ```bash | ||
| $ go get github.com/nautobot/go-nautobot/pkg/[email protected].0 | ||
| $ go get github.com/nautobot/go-nautobot/pkg/[email protected].8-beta | ||
| ``` | ||
|
|
||
| ### Go main example |
There was a problem hiding this comment.
"This is example" -> remove is
chadell
commented
Mar 15, 2023
chadell
commented
Mar 15, 2023
Co-authored-by: Cristian <[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.
addresses issue #3