Merge pull request #2823 from camilamacedo86/readme

📖 Update the README

Author: k8s-ci-robot

README.md

@@ -12,10 +12,26 @@ Kubebuilder increases velocity and reduces the complexity managed by
 developers for rapidly building and publishing Kubernetes APIs in Go.
 It builds on top of the canonical techniques used to build the core Kubernetes APIs to provide simple abstractions that reduce boilerplate and toil.
 
-**Note:** Kubebuilder does not exist as an example to *copy-paste*, but instead provides powerful libraries and tools
-to simplify building and publishing Kubernetes APIs from scratch.
+Kubebuilder does **not** exist as an example to *copy-paste*, but instead provides powerful libraries and tools
+to simplify building and publishing Kubernetes APIs from scratch. On to of that, it 
+provides an plugin architecture which allows users take advantage of optional helpers
+and features. To know more about see the [Plugin section][plugin-section].
 
-Kubebuilder is developed on top of the controller-runtime and controller-tools libraries.
+Kubebuilder is developed on top of the [controller-runtime][controller-runtime] and [controller-tools][controller-tools] libraries.
+
+### Kubebuilder is also a framework for other tools
+
+Kubebuilder is extensible and can be imported to be used as a library in other projects.
+Specifically, for those which are looking for a way to use Kubebuilder's existing CLI and scaffolding the projects and re-use its plugins, 
+but to also be able to augment the Kubebuilder project structure with other custom project types so that it is possible to support the Kubebuilder 
+workflow with non-Go operators. 
+
+A good example of its usage is the project [Operator-SDK][operator-sdk]
+that uses Kubebuilder as lib to generate the scaffolds and create its own helper plugins 
+to provide additional features and options on top. [Operator-SDK][operator-sdk] also uses Kubebuilder
+to support their workflow with non-Go operators (_e.g. operator-sdk's Ansible and Helm-based language Operators_)
+
+To know more about see [how to create your own plugins][your-own-plugins]. 
 
 ### Installation
 
@@ -38,8 +54,8 @@ Check out the Kubebuilder [book](https://book.kubebuilder.io).
 - GitHub Repo: [kubernetes-sigs/kubebuilder](https://github.com/kubernetes-sigs/kubebuilder)
 - Slack channel: [#kubebuilder](https://slack.k8s.io/#kubebuilder)
 - Google Group: [[email protected]](https://groups.google.com/forum/#!forum/kubebuilder)
-- Planned Work: [Sprint Dashboard](https://github.com/kubernetes-sigs/kubebuilder/projects/1)
 - Design Documents: [designs](designs/).
+- Plugin: [plugins][plugin-section]
 
 ## Motivation
 
@@ -105,7 +121,21 @@ Before starting any work, please either comment on an existing issue, or file a
 
 ## Supportability
 
-Currently, Kubebuilder officially supports OSX and Linux platforms. So, if you are using a Windows OS you may find issues. Contributions towards supporting Windows are welcome.
+Currently, Kubebuilder officially supports OSX and Linux platforms. 
+So, if you are using a Windows OS you may find issues. Contributions towards 
+supporting Windows are welcome.
+
+### Apple Silicon
+
+The current scaffold done by the CLI (`go/v3`) when we run `kubebuilder init` uses [kubernetes-sigs/kustomize][kustomize] v3 which does not provide
+a valid binary for Apple Silicon (`darwin/arm64`). Therefore, you can use the `go/v4-alpha` plugin
+instead which provides support for this platform:
+
+```bash
+kubebuilder init --domain my.domain --repo my.domain/guestbook --plugins=go/v4-alpha
+```
+
+**Note**: The `go/v4-alpha` plugin is an unstable version and can have breaking changes in future releases.
 
 ## Community Meetings
 
@@ -116,3 +146,8 @@ The following meetings happen biweekly:
 
 You are more than welcome to attend. For further info join to [[email protected]](https://groups.google.com/g/kubebuilder).
 
+[operator-sdk]: https://github.com/operator-framework/operator-sdk
+[plugin-section]: https://book.kubebuilder.io/plugins/plugins.html
+[controller-runtime]: https://github.com/kubernetes-sigs/controller-runtime
+[your-own-plugins]: https://book.kubebuilder.io/plugins/creating-plugins.html
+[controller-tools]: https://github.com/kubernetes-sigs/controller-tools