Skip to content

Commit

Permalink
README update (#111)
Browse files Browse the repository at this point in the history
Signed-off-by: Ken Sipe <kensipe@gmail.com>
  • Loading branch information
kensipe committed May 22, 2020
1 parent d31f3a7 commit d5090aa
Showing 1 changed file with 32 additions and 21 deletions.
53 changes: 32 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,40 @@
# kuttl
KUbernetes Test TooL (kuttl)
# KUTTL

## Installation
<img src="https://kuttl.dev/images/kuttl-horizontal-logo.png" width="256">

Brew Install
```bash
brew install kuttl-cli
```
[![CircleCI](https://circleci.com/gh/kudobuilder/kuttl.svg?style=svg)](https://circleci.com/gh/kudobuilder/kuttl)

Krew Install
```bash
kubectl krew install kuttl
```
KUbernetes Test TooL (KUTTL) provides a declarative approach to test Kubernetes Operators.

Go Install
```bash
cd $(mktemp -d) && go get github.com/kudobuilder/kuttl/cmd/kubectl-kuttl && cd -
```
KUTTL is designed for testing operators, however it can declaratively test any kubernetes objects.

## Usage
## Getting Started

For usage, see
Please refer to the [getting started guide](https://kuttl.dev/docs/) documentation.

```bash
kubectl kuttl
```
## Resources

or the documentation: http://kuttl.dev
Initially Built under the KUDO project, we continue to use that channel for KUTTL.

* Slack Channel: [#kudo](https://kubernetes.slack.com/archives/CG3HTFCMV)
* Google Group: [kudobuilder@googlegroups.com](https://groups.google.com/forum/#!forum/kudobuilder)

## Community Meetings

We have open community meetings every 2nd and 4th Wednesday of the month at 9:00 a.m. PST. (17:00 UTC)

* Agenda and Notes: https://docs.google.com/document/d/1UqgtCMUHSsOohZYF8K7zX8WcErttuMSx7NbvksIbZgg
* Zoom Meeting: https://d2iq.zoom.us/j/443128842


## Community, Events, Discussion, Contribution, and Support

Learn more on how to engage with the KUDO community on the [community page](https://kudo.dev/community/).

## Contributions

Please read the [contributing guide](https://github.com/kudobuilder/kuttl/blob/master/CONTRIBUTING.md) for details around:

1. Code of Conduct
1. Code Culture
1. Details on how to contribute

0 comments on commit d5090aa

Please sign in to comment.