From 2355978b1ffd899cb6c70b140f1428754fc5226c Mon Sep 17 00:00:00 2001 From: Vigith Maurice Date: Sat, 5 Nov 2022 10:22:56 -0700 Subject: [PATCH] doc: add few use cases (#318) Signed-off-by: Vigith Maurice --- README.md | 13 +++++++++++-- docs/README.md | 13 +++++++++++-- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 72139ccba1..eed5bdcaaa 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,18 @@ ## Summary -Numaflow is a Kubernetes-native tool for running massively parallel stream processing. A Numaflow Pipeline is implemented as a Kubernetes custom resource and consists of one or more source, data processing, and sink vertices. +Numaflow is a Kubernetes-native tool for running massively parallel stream processing. A Numaflow Pipeline is implemented +as a Kubernetes custom resource and consists of one or more source, data processing, and sink vertices. -Numaflow installs in a few minutes and is easier and cheaper to use for simple data processing applications than a full-featured stream processing platforms. +Numaflow installs in a few minutes and is easier and cheaper to use for simple data processing applications than a +full-featured stream processing platforms. + +## Use Cases + +- Real-time data analytics applications. +- Event driven applications such as anomaly detection, monitoring and alerting. +- Streaming applications such as data instrumentation and data movement. +- Workflows running in a streaming manner. ## Key Features diff --git a/docs/README.md b/docs/README.md index 9990e4bd4a..36190d9bfe 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,17 @@ # Numaflow -Numaflow is a Kubernetes-native tool for running massively parallel stream processing. A Numaflow Pipeline is implemented as a Kubernetes custom resource and consists of one or more source, data processing, and sink vertices. +Numaflow is a Kubernetes-native tool for running massively parallel stream processing. A Numaflow Pipeline is implemented +as a Kubernetes custom resource and consists of one or more source, data processing, and sink vertices. -Numaflow installs in a few minutes and is easier and cheaper to use for simple data processing applications than a full-featured stream processing platforms. +Numaflow installs in a few minutes and is easier and cheaper to use for simple data processing applications than a full-featured +stream processing platforms. + +## Use Cases + +- Real-time data analytics applications. +- Event driven applications such as anomaly detection, monitoring and alerting. +- Streaming applications such as data instrumentation and data movement. +- Workflows running in a streaming manner. ## Key Features