You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@streampipes.apache.org by wi...@apache.org on 2020/09/01 07:23:36 UTC

[incubator-streampipes] branch dev updated: [hotfix] edit installation description to fit to new options

This is an automated email from the ASF dual-hosted git repository.

wiener pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/incubator-streampipes.git


The following commit(s) were added to refs/heads/dev by this push:
     new 825c45b  [hotfix] edit installation description to fit to new options
825c45b is described below

commit 825c45be40ba104a1843ed81c8e547ac6e6f4513
Author: Patrick Wiener <wi...@fzi.de>
AuthorDate: Tue Sep 1 09:20:45 2020 +0200

    [hotfix] edit installation description to fit to new options
---
 README.md | 25 ++++++++++++-------------
 1 file changed, 12 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 9b56b73..fd6ec4b 100644
--- a/README.md
+++ b/README.md
@@ -58,10 +58,9 @@
 ## About Apache StreamPipes
 
 Apache StreamPipes (incubating) enables flexible modeling of stream processing pipelines by providing a graphical
- modeling
- editor on top of existing stream processing frameworks.
+ modeling editor on top of existing stream processing frameworks.
 
-It leverages non-technical users to quickly define and execute processing pipelines based on an easily extensible 
+It empowers non-technical users to quickly define and execute processing pipelines based on an easily extensible 
 toolbox of data sources, data processors and data sinks. StreamPipes has an exchangeable runtime execution layer and executes pipelines using one of the provided wrappers, e.g., for Apache Flink or Apache Kafka Streams.
 
 Pipeline elements in StreamPipes can be installed at runtime - the built-in SDK allows to easily implement new 
@@ -69,8 +68,8 @@ pipeline elements according to your needs. Pipeline elements are standalone micr
 
 ## Use Cases
 
-StreamPipes allows you to connect IoT data sources using the SDK or the built-in graphical tool StreamPipes 
-Connect.
+StreamPipes allows you to connect IoT data sources using the SDK or the built-in graphical tool **StreamPipes 
+Connect**.
 
 The extensible toolbox of data processors and sinks supports use cases such as
 * Continuously **store** IoT data streams to third party systems (e.g., databases)
@@ -84,15 +83,15 @@ The extensible toolbox of data processors and sinks supports use cases such as
 
 ## Installation
 
-The quickest way to run StreamPipes is the Docker-based installer script available for Unix, Mac and Windows (10).
+The quickest way to run StreamPipes is by using our Docker-based [installation & operation options](https://www.github.com/apache/dev/incubator-streampipes-installer/tree/dev), namely: 
 
-It's easy to get started:
-1. Make sure you have [Docker](https://docs.docker.com/install/) and [Docker Compose](https://docs.docker.com/compose/install/) installed.
-2. Clone or download the installer script from [https://www.github.com/apache/incubator-streampipes-installer](https://www.github.com/apache/incubator-streampipes-installer)
-3. Execute ``./streampipes start`` 
-4. Enter the hostname and choose the version you'd like to run (the Lite version runs with less memory assigned to Docker (< 6 GB), use the full version if you have more memory available)
-5. Open your browser, navigate to ``http://YOUR_HOSTNAME_HERE`` and follow the installation instructions.
-6. Once finished, switch to the pipeline editor and start the interactive tour or check the [online tour](https://streampipes.apache.org/docs/docs/user-guide-tour/) to learn how to create your first pipeline!
+* **[StreamPipes Compose](https://github.com/apache/incubator-streampipes-installer/tree/dev/compose)** - The User's Choice
+* **[StreamPipes CLI](https://github.com/apache/incubator-streampipes-installer/tree/dev/cli)** - The Developer's Favorite
+* **[StreamPipes k8s](https://github.com/apache/incubator-streampipes-installer/tree/dev/k8s)** - The Operator's Dream
+
+> **NOTE**: StreamPipes CLI & k8s are highly recommended for developers or operators. Standard users should stick to StreamPipes Compose.
+
+Please follow the instructions provided in the corresponding `README.md` to get started.
 
 For a more in-depth manual, read the installation guide at [https://streampipes.apache.org/docs/docs/user-guide-installation/](https://streampipes.apache.org/docs/docs/user-guide-installation/)!