Skip to content

Commit

Permalink
docs: Updated README.md (#1151)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexec authored Mar 31, 2021
1 parent 2fa5185 commit 2df1bdd
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 7 deletions.
27 changes: 20 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,40 @@
[![slack](https://img.shields.io/badge/slack-argoproj-brightgreen.svg?logo=slack)](https://argoproj.github.io/community/join-slack)
[![Build Status](https://travis-ci.org/argoproj/argo-events.svg?branch=master)](https://travis-ci.org/argoproj/argo-events)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/3832/badge)](https://bestpractices.coreinfrastructure.org/projects/3832)
[![GoDoc](https://godoc.org/github.com/argoproj/argo-events?status.svg)](https://godoc.org/github.com/argoproj/argo-events/pkg/apis)
[![GoDoc](https://godoc.org/github.com/argoproj/argo-events?status.svg)](https://godoc.org/github.com/argoproj/argo-events/pkg/apis)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)

## What is Argo Events?

**Argo Events** is an event-driven workflow automation framework for Kubernetes. It allows you to trigger 10 different actions (such as the creation of Kubernetes objects, invoke workflows or serverless workloads) on over 20 different events (such as webhook, S3 drop, cron schedule, messaging queues - e.g. Kafka, GCP PubPub, SNS, SQS).
**Argo Events** is an event-driven workflow automation framework for Kubernetes. It allows you to trigger 10 different
actions (such as the creation of Kubernetes objects, invoke workflows or serverless workloads) on over 20 different
events (such as webhook, S3 drop, cron schedule, messaging queues - e.g. Kafka, GCP PubPub, SNS, SQS).

[![Argo Events in 3 minutes](https://img.youtube.com/vi/Aqi1zyTpM44/0.jpg)](https://youtu.be/Aqi1zyTpM44)

## Features

* Supports events from [20+ event sources](https://argoproj.github.io/argo-events/concepts/event_source/) and [10+ triggers](https://argoproj.github.io/argo-events/concepts/trigger/).
* Supports events from [20+ event sources](https://argoproj.github.io/argo-events/concepts/event_source/)
and [10+ triggers](https://argoproj.github.io/argo-events/concepts/trigger/).
* Ability to customize business-level constraint logic for workflow automation.
* Manage everything from simple, linear, real-time to complex, multi-source events.
* [CloudEvents](https://cloudevents.io/) compliant.

## Try Argo Events

[Access the demo enviromnment](https://workflows.apps.argoproj.io/event-flow/argo?showWorkflows=true) (login using Github)
[Access the demo environment](https://workflows.apps.argoproj.io/event-flow/argo?showWorkflows=true) (login using
Github)

![Screenshot](docs/assets/screenshot.png)

## Getting Started

Follow these [instruction](https://argoproj.github.io/argo-events/installation/) to set up Argo Events.

## User Interface/API

The Argo Workflows has an API and user interface support Argo Events.

## Documentation

- [Concepts](https://argoproj.github.io/argo-events/concepts/architecture/)
Expand All @@ -42,17 +52,20 @@ Follow these [instruction](https://argoproj.github.io/argo-events/installation/)
* [Argo Events Deep-dive](https://youtu.be/U4tCYcCK20w)
* [Automating Research Workflows at BlackRock](https://www.youtube.com/watch?v=ZK510prml8o)
* [Designing A Complete CI/CD Pipeline CI/CD Pipeline Using Argo Events, Workflows, and CD](https://www.slideshare.net/JulianMazzitelli/designing-a-complete-ci-cd-pipeline-using-argo-events-workflow-and-cd-products-228452500)
* TGI Kubernetes with Joe Beda: [CloudEvents and Argo Events](https://www.youtube.com/watch?v=LQbBgQnUs_k&list=PL7bmigfV0EqQzxcNpmcdTJ9eFRPBe-iZa&index=2&t=0s)
* TGI Kubernetes with Joe
Beda: [CloudEvents and Argo Events](https://www.youtube.com/watch?v=LQbBgQnUs_k&list=PL7bmigfV0EqQzxcNpmcdTJ9eFRPBe-iZa&index=2&t=0s)

## Who uses Argo Events?

[Official Argo Events user list](USERS.md)

## Contribute

Participation in the Argo Events project is governed by the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
Participation in the Argo Events project is governed by
the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

[Contributions](https://github.com/argoproj/argo-events/issues) are more than welcome, if you are interested take a look at our [Contributing Guidelines](./CONTRIBUTING.md).
[Contributions](https://github.com/argoproj/argo-events/issues) are more than welcome, if you are interested take a look
at our [Contributing Guidelines](./CONTRIBUTING.md).

## License

Expand Down
Binary file added docs/assets/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2df1bdd

Please sign in to comment.