fix(docs): readme for UI development (#181)

Signed-off-by: Derek Wang <[email protected]>

docs/README.md

@@ -1,14 +1,22 @@
 # Numaflow
 
-Numaflow is a Kubernetes-native platform for running massive parallel data processing and streaming jobs. 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.
 
 ## Key Features
 
-- Kubernetes-native: If you know Kubernetes, you already know 90% of what you need to use Numaflow.
+- Kubernetes-native: If you know Kubernetes, you already know how to use Numaflow.
 - Language agnostic: Use your favorite programming language.
 - Exactly-Once semantics: No input element is duplicated or lost even as pods are rescheduled or restarted.
 - Auto-scaling with back-pressure: Each vertex automatically scales from zero to whatever is needed.
 
+## Data Integrity Guarantees:
+
+- Minimally provide at-least-once semantics
+- Provide exactly-once semantics for unbounded and near real-time data sources
+- Preserving order is not required
+
 ## Roadmap
 
 - Data aggregation (e.g. group-by)

ui/README.md

@@ -1,27 +1,22 @@
 # Numaflow UI
 
-![Numaflow Image](../docs/assets/numa.svg)
+![Numaflow Image](../docs/assets/numaproj.svg)
 
 A web-based UI for Numaflow
 
 The UI has the following features:
 * View running pipelines in your namespace
 * View Vertex and Edge Information of your pipeline
 * View BackPressure and Pending Messages
-* View Container (main/udf) Logs for a given vertex
+* View Container Logs for a given vertex
 
 ## Development
 
-This  explains how to set up a development environment so you can get started with UI development
+See [Development Guide](../docs/development.md).
 
-### Prerequisites
-
-Follow the instructions below to set up your development environment.
-
-### Install requirements
-
-These tools are required for development.
-
-1. [`Numaflow`](https://github.com/numaproj/numaflow/blob/master/docs/DEVELOPMENT.md): Follow the document to prepare `Numaflow` development environment.
-1. [`node`](https://nodejs.org/en/download/): NodeJS - `brew install node`.
-1. [`yarn`](https://yarnpkg.com/): Package manager - `brew install yarn`
+```shell
+# Build image and deploy to a k3d cluster
+make start
+# Port-forward, and access https://localhost:8443
+kubectl -n numaflow-system port-forward svc/numaflow-server 8443
+```