Skip to content

Commit

Permalink
Update widgets (add godoc) as well as README
Browse files Browse the repository at this point in the history
Update the widgets (as well as add godoc), and update the README, making
the `kompose completion` section more concise.
  • Loading branch information
cdrage committed Jun 8, 2017
1 parent f066834 commit 7101d62
Showing 1 changed file with 14 additions and 12 deletions.
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# Kompose (Kubernetes + Compose)

[![Build Status](https://travis-ci.org/kubernetes-incubator/kompose.svg?branch=master)](https://travis-ci.org/kubernetes-incubator/kompose)
[![Coverage Status](https://coveralls.io/repos/github/kubernetes-incubator/kompose/badge.svg?branch=master)](https://coveralls.io/github/kubernetes-incubator/kompose?branch=master)

[![Join us in #kompose on k8s Slack](https://s3.eu-central-1.amazonaws.com/ngtuna/join-us-on-slack.png)](http://slack.kubernetes.io) in #kompose channel
[![Build Status Widget]][Build Status] [![Coverage Status Widget]][Coverage Status] [![GoDoc Widget]][GoDoc] [![Slack Widget]][Slack]

`kompose` is a tool to help users who are familiar with `docker-compose` move to [Kubernetes](http://kubernetes.io). `kompose` takes a Docker Compose file and translates it into Kubernetes resources.

Expand Down Expand Up @@ -60,17 +57,13 @@ Alternatively, you can download the less-bandwidth intense [tarball](https://git

## Shell autocompletion

We support both `bash` and `zsh` for autocompletion.

Bash:
We support both Bash and Zsh autocompletion.

```console
```sh
# Bash (add to .bashrc for persistence)
source <(kompose completion bash)
```

Zsh:

```console
# Zsh (add to .zshrc for persistence)
source <(kompose completion zsh)
```

Expand Down Expand Up @@ -130,3 +123,12 @@ An up-to-date roadmap of upcoming releases is located at [ROADMAP.md](/ROADMAP.m
### Code of Conduct

Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md).

[Build Status]: https://travis-ci.org/kubernetes-incubator/kompose
[Build Status Widget]: https://travis-ci.org/kubernetes-incubator/kompose.svg?branch=master
[GoDoc]: https://godoc.org/github.com/kubernetes-incubator/kompose
[GoDoc Widget]: https://godoc.org/github.com/kubernetes-incubator/kompose?status.svg
[Slack]: http://slack.kubernetes.io#kompose
[Slack Widget]: https://s3.eu-central-1.amazonaws.com/ngtuna/join-us-on-slack.png
[Coverage Status Widget]: https://coveralls.io/repos/github/kubernetes-incubator/kompose/badge.svg?branch=master
[Coverage Status]: https://coveralls.io/github/kubernetes-incubator/kompose?branch=master

0 comments on commit 7101d62

Please sign in to comment.