Skip to content

Commit 046375a

Browse files
committed
Add godoc links to README.md
1 parent 0fdcf26 commit 046375a

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,21 @@ bin/controller-manager --kubeconfig ~/.kube/config
3232

3333
See the [user guide](docs/tools_user_guide.md) for more details
3434

35+
## Godocs
36+
37+
Many of the kubebuilder libraries can be used on their own without the kubebuilder code generation and scaffolding.
38+
39+
See examples of using the libraries directly below:
40+
41+
- [controller libraries](https://godoc.org/github.com/kubernetes-sigs/kubebuilder/pkg/controller)
42+
- [config libraries](https://godoc.org/github.com/kubernetes-sigs/kubebuilder/pkg/config)
43+
- [signals libraries](https://godoc.org/github.com/kubernetes-sigs/kubebuilder/pkg/signals)
44+
45+
Kubebuilder code generation tags can be found here:
46+
47+
- [resource code generation tags](https://godoc.org/github.com/kubernetes-sigs/kubebuilder/pkg/gen/apis)
48+
- [controllers code generation tags](https://godoc.org/github.com/kubernetes-sigs/kubebuilder/pkg/gen/controller)
49+
3550
## Motivation
3651

3752
Building Kubernetes tools and APIs involves making a lot of decisions and writing a lot of boilerplate.

0 commit comments

Comments
 (0)