-
Notifications
You must be signed in to change notification settings - Fork 84
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
README for runtime package #125
Conversation
99cdd69
to
5190205
Compare
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
This makes them part of the public API (and thereby makes them documented) and allows overwrites in case this is ever required. Signed-off-by: Hidde Beydals <hello@hidde.co>
0dbb9a4
to
78aac43
Compare
Signed-off-by: Hidde Beydals <hello@hidde.co>
6063339
to
15f17a1
Compare
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
2c9909a
to
0b3d042
Compare
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
6cc9688
to
f7a1d07
Compare
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
Signed-off-by: Hidde Beydals <hello@hidde.co>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Commented offline.
This reads so incredibly well 👏 🏆
lgtm! 🚀
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
<3 to see this quality of docs; thank you Hidde.
## Usage | ||
|
||
To use the packages in your project, import `github.com/fluxcd/pkg/runtime` using `go get` or your dependency manager | ||
of choice: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there any option other than go get (or go get, implicitly, via other go commands)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't want to imply that using Go Modules is a strict requirement, using e.g. dep ensure
should work perfectly fine as well.
Signed-off-by: Hidde Beydals <hello@hidde.co>
Fixes #118