diff --git a/readme.md b/readme.md index 7e216068..41d8a397 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,21 @@ -[![CircleCI](https://circleci.com/gh/keel-hq/keel/tree/master.svg?style=shield&circle-token=0239846a42cfa188de531058b9a2116a4b8600d8)](https://hub.docker.com/r/karolisr/keel/) [![Go Report Card](https://goreportcard.com/badge/github.com/keel-hq/keel)](https://goreportcard.com/report/github.com/keel-hq/keel) [![Pulls](https://img.shields.io/docker/pulls/karolisr/keel.svg)](https://img.shields.io/docker/pulls/karolisr/keel.svg) +

+ +

+ +

+ + + CircleCI + + + + Go Report + + + + Docker Pulls + +

# Keel - automated Kubernetes deployments for the rest of us @@ -17,31 +34,39 @@ Keel provides several key features: * __Automatic [Google Container Registry](https://cloud.google.com/container-registry/) configuration__ - Keel automatically sets up topic and subscriptions for your deployment images by periodically scanning your environment. -* __[Native, DockerHub and Quay webhooks](https://keel.sh/user-guide/triggers/#webhooks) support__ - once webhook is received impacted deployments will be identified and updated. +* __[Native, DockerHub and Quay webhooks](https://keel.sh/v1/guide/documentation.html#Triggers) support__ - once webhook is received impacted deployments will be identified and updated. -* __[Polling](https://keel.sh/user-guide/#polling-deployment-example)__ - when webhooks and pubsub aren't available - Keel can still be useful by checking Docker Registry for new tags (if current tag is semver) or same tag SHA digest change (ie: `latest`). +* __[Polling](https://keel.sh/v1/guide/documentation.html#Polling)__ - when webhooks and pubsub aren't available - Keel can still be useful by checking Docker Registry for new tags (if current tag is semver) or same tag SHA digest change (ie: `latest`). -* __Notifications__ - out of the box Keel has Slack and standard webhook notifications, more info [here](https://keel.sh/user-guide/#notifications) +* __Notifications__ - out of the box Keel has Slack and standard webhook notifications, more info [here](https://keel.sh/v1/guide/documentation.html#Notifications) - +

+ +

### Support -Support Keel's development with: +Support Keel's development by: * [Patreon](https://patreon.com/keel) * [Paypal](https://www.paypal.me/keelhq) +* Star this repository +* [Follow on Twitter](https://twitter.com/keel_hq) ### Quick Start +

+ +

+ A step-by-step guide to install Keel on your Kubernetes cluster is viewable on the Keel website: -[https://keel.sh/install](https://keel.sh/install) +[https://keel.sh/v1/guide/quick-start.html](https://keel.sh/v1/guide/quick-start.html) ### Documentation Documentation is viewable on the Keel Website: -[https://keel.sh/user-guide/](https://keel.sh/user-guide/) +[https://keel.sh/v1/guide/documentation](https://keel.sh/v1/guide/documentation) ### Contributing