Skip to content

Commit 2489b81

Browse files
authored
Merge pull request #325 from droot/readme-update
Updated the intro movie and cleaned up the README a bit.
2 parents d55a06e + f84501d commit 2489b81

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
11
[![Build Status](https://travis-ci.org/kubernetes-sigs/kubebuilder.svg?branch=master)](https://travis-ci.org/kubernetes-sigs/kubebuilder "Travis")
22
[![Go Report Card](https://goreportcard.com/badge/github.com/kubernetes-sigs/kubebuilder)](https://goreportcard.com/report/github.com/kubernetes-sigs/kubebuilder)
33

4-
*Don't use `go get` / `go install`, instead you MUST download a tar binary release or create your own release using
5-
the release program.* To build your own release see [CONTRIBUTING.md](CONTRIBUTING.md)
6-
7-
## `kubebuilder`
4+
## Kubebuilder
85

96
Kubebuilder is a framework for building Kubernetes APIs using [custom resource definitions (CRDs)](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions).
107

118
**Note:** kubebuilder does not exist as an example to *copy-paste*, but instead provides powerful libraries and tools
129
to simplify building and publishing Kubernetes APIs from scratch.
1310

14-
### Download and Install
11+
### Installalation
12+
13+
It is strongly recommended that you use a released version. Release binaries are available on the [releases](https://github.com/kubernetes-sigs/kubebuilder/releases) page.
14+
Follow the [instructions](http://book.kubebuilder.io/getting_started/installation_and_setup.html) to install Kubebuilder.
1515

16-
[Releases](https://github.com/kubernetes-sigs/kubebuilder/releases) are here
1716

1817
## Getting Started
1918

2019
See the [Getting Started](http://book.kubebuilder.io/quick_start.html) documentation.
2120

22-
![Quick Start](docs/gif/quickstart.gif)
21+
![Quick Start](docs/gif/quickstart-1.0.0.gif)
2322

2423
## Documentation
2524

@@ -80,3 +79,8 @@ Before you file an issue, please search existing issues to see if your issue is
8079

8180
- ### Slack
8281
For realtime discussion, you can join the [#kubebuilder](https://slack.k8s.io/#kubebuilder) slack channel. Slack requires registration, but the Kubernetes team is open invitation to anyone to register here. Feel free to come and ask any questions.
82+
83+
## Contributing
84+
Contributions are greatly appreciated. The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers.
85+
The project follows the typical GitHub pull request model. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
86+
Before starting any work, please either comment on an existing issue, or file a new one.

docs/gif/quickstart-1.0.0.gif

309 KB
Loading

0 commit comments

Comments
 (0)