From 908e1685d78d12c87fe955eec8ad0df964b3d98b Mon Sep 17 00:00:00 2001 From: Saradhi Sreegiriraju Date: Sat, 18 Apr 2020 17:50:28 -0700 Subject: [PATCH] docs: Update README.md (#2751) Update README to remove Argoproj level content to make the README specific to Argo Workflows. --- README.md | 27 ++++++--------------------- 1 file changed, 6 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 234a6a803091..ebb84e113c0c 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,6 @@ [![CircleCI](https://circleci.com/gh/argoproj/argo.svg?style=svg)](https://circleci.com/gh/argoproj/argo) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=argoproj_argo&metric=alert_status)](https://sonarcloud.io/dashboard?id=argoproj_argo) -# Argoproj - Get stuff done with Kubernetes - -![Argo Image](docs/assets/argo.png) - -## Quickstart -```bash -kubectl create namespace argo -kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo/stable/manifests/install.yaml -``` - -## What is Argoproj? - -Argoproj is a collection of tools for getting work done with Kubernetes. -* [Argo Workflows](https://github.com/argoproj/argo) - Container-native Workflow Engine -* [Argo CD](https://github.com/argoproj/argo-cd) - Declarative GitOps Continuous Delivery -* [Argo Events](https://github.com/argoproj/argo-events) - Event-based Dependency Manager -* [Argo Rollouts](https://github.com/argoproj/argo-rollouts) - Progressive Delivery with support for Canary and Blue Green deployment strategies - -Also argoproj-labs is a separate GitHub org that we setup for community contributions related to the Argoproj ecosystem. Repos in argoproj-labs are administered by the owners of each project. Please reach out to us on the Argo slack channel if you have a project that you would like to add to the org to make it easier to others in the Argo community to find, use, and contribute back. -* https://github.com/argoproj-labs - ## What is Argo Workflows? Argo Workflows is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. Argo Workflows is implemented as a Kubernetes CRD (Custom Resource Definition). @@ -37,6 +16,12 @@ Argo Workflows is an open source container-native workflow engine for orchestrat * Easily orchestrate highly parallel jobs on Kubernetes. * Argo Workflows puts a cloud-scale supercomputer at your fingertips! +## Quickstart +```bash +kubectl create namespace argo +kubectl apply -n argo -f https://raw.githubusercontent.com/argoproj/argo/stable/manifests/install.yaml +``` + ## Who uses Argo Workflows? [Official Argo Workflows user list](USERS.md)