From c553cc3ed3219da87303871a6e81efb83c98a202 Mon Sep 17 00:00:00 2001 From: Maciej Pytel Date: Fri, 21 Jul 2017 11:30:30 +0200 Subject: [PATCH] Add godoc widget to readme --- README.md | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f7a1ddb544..05924ffb00 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Kubernetes Autoscaler -[![Build Status](https://travis-ci.org/kubernetes/autoscaler.svg?branch=master)](https://travis-ci.org/kubernetes/autoscaler) +[![Build Status](https://travis-ci.org/kubernetes/autoscaler.svg?branch=master)](https://travis-ci.org/kubernetes/autoscaler) [![GoDoc Widget]][GoDoc] This repository contains autoscaling-related components for Kubernetes. @@ -9,20 +9,20 @@ This repository contains autoscaling-related components for Kubernetes. [Cluster Autoscaler](https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler) - a component that automagically adjusts the size of a Kubernetes Cluster so that all pods have a place to run and there are no unneeded nodes. Works with GCP, AWS and Azure. Current state - late beta, moving towards GA. -[Vertical Pod Autoscaler](https://github.com/kubernetes/autoscaler/tree/master/vertical-pod-autoscaler) - a set of components to automagically adjust the +[Vertical Pod Autoscaler](https://github.com/kubernetes/autoscaler/tree/master/vertical-pod-autoscaler) - a set of components to automagically adjust the amount of CPU and memory requested by pods running in the Kubernetes Cluster. Current state - under development. -[Addon Resizer](https://github.com/kubernetes/autoscaler/tree/master/addon-resizer) - a simplified version of vertical pod autoscaler that modifies -resource requests of a deployment based on the number of nodes in the Kubernetes Cluster. Current state - beta. +[Addon Resizer](https://github.com/kubernetes/autoscaler/tree/master/addon-resizer) - a simplified version of vertical pod autoscaler that modifies +resource requests of a deployment based on the number of nodes in the Kubernetes Cluster. Current state - beta. ## Contact Info Interested in autoscaling? Want to talk? Have questions, concenrns or great ideas? Please join us on #sig-autoscaling at https://kubernetes.slack.com/. -Moreover, every Thursday we host a 30min sig-autoscaling meeting on +Moreover, every Thursday we host a 30min sig-autoscaling meeting on https://hangouts.google.com/hangouts/_/google.com/sig-autoscaling at -17:30 CEST/CET, 8:30 am PST/PDT. +17:30 CEST/CET, 8:30 am PST/PDT. ## Getting the Code @@ -34,4 +34,7 @@ cd $GOPATH/src/k8s.io # Replace "$YOUR_GITHUB_USERNAME" below with your github username git clone https://github.com/$YOUR_GITHUB_USERNAME/autoscaler.git cd autoscaler -``` \ No newline at end of file +``` + +[GoDoc]: https://godoc.org/k8s.io/autoscaler +[GoDoc Widget]: https://godoc.org/k8s.io/autoscaler?status.svg