From f1024dc4439da196721f19ea774616c51f058323 Mon Sep 17 00:00:00 2001 From: Kent Rancourt Date: Tue, 18 Apr 2023 00:01:17 -0400 Subject: [PATCH] readme cleanup (#325) Signed-off-by: Kent --- README.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0b6948117..1c52e72fb 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,23 @@ - -![Kargo Open Source project from Akuity, creators of Argo](kargo-logo.png) +![Kargo by Akuity, creators of Argo](kargo-logo.png) ![CI](https://github.com/akuity/kargo/actions/workflows/ci.yaml/badge.svg) -[![codecov](https://codecov.io/gh/akuity/kargo/branch/main/graph/badge.svg?token=DWEYXEJCYZ)](https://codecov.io/gh/akuity/kargo) +[![Netlify Status](https://api.netlify.com/api/v1/badges/c4e62c70-e07d-4ac6-bcf8-d7003c936d19/deploy-status)](https://app.netlify.com/sites/docs-kargo-akuity-io/deploys) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md) -Placeholder +Kargo helps GitOps practitioners streamline continuous delivery for Kubernetes +by automating the progression of changes from one environment to the next. -> 🟡  Kargo is highly experimental at this time and breaking changes +> ⚠️  Kargo is highly experimental at this time and breaking changes > should be anticipated between pre-GA minor releases. ## Getting Started -Read more about Kargo in our [docs](https://docs-kargo-akuity-io.netlify.app/) -and then try it yourself by following our -[Quickstart](https://docs-kargo-akuity-io.netlify.app/quickstart). +Read more about Kargo and try it yourself by following our +[Quickstart](https://docs-kargo-akuity-io.netlify.app). This documentation is very new, so please open issues against this repository if you encounter any difficulties with it. -## Roadmap - -Visit our [Roadmap](https://docs-kargo-akuity-io.netlify.app/roadmap) for -frequently updated details about what we've accomplished so far and what we're -currently working on. - ## Contributing The Kargo project accepts contributions via GitHub pull requests.