streampipes-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rie...@apache.org
Subject [incubator-streampipes-extensions] branch dev updated: Update README
Date Sun, 29 Dec 2019 08:11:23 GMT
This is an automated email from the ASF dual-hosted git repository.

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


The following commit(s) were added to refs/heads/dev by this push:
     new 02984d7  Update README
02984d7 is described below

commit 02984d746d5dd45c166f4058d03f88f6e4f43968
Author: Dominik Riemer <riemer@fzi.de>
AuthorDate: Sun Dec 29 09:11:10 2019 +0100

    Update README
---
 README.md | 86 ++++++++++++++++++++++++---------------------------------------
 1 file changed, 32 insertions(+), 54 deletions(-)

diff --git a/README.md b/README.md
index e241d15..468098f 100644
--- a/README.md
+++ b/README.md
@@ -16,75 +16,53 @@
   ~
   -->
 
-# StreamPipes
+# Apache StreamPipes
 
-StreamPipes enables flexible modeling of stream processing pipelines by providing a graphical
modeling editor on top of existing stream processing frameworks.
+Apache StreamPipes (incubating) enables flexible modeling of stream processing pipelines
by providing a graphical
+ 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 
-toolbox of data sources, data processors and data sinks.
+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.
 
-Learn more about StreamPipes at [https://www.streampipes.org/](https://www.streampipes.org/)
+Pipeline elements in StreamPipes can be installed at runtime - the built-in SDK allows to
easily implement new 
+pipeline elements according to your needs. Pipeline elements are standalone microservices
that can run anywhere - centrally on your server, in a large-scale cluster or close at the
edge.
 
-Read the full documentation at [https://docs.streampipes.org](https://docs.streampipes.org)
+
+Learn more about StreamPipes at [https://streampipes.apache.org/](https://streampipes.apache.org/)
+
+Read the full documentation at [https://streampipes.apache.org/docs](https://streampipes.apache.org/docs)
 
 ### StreamPipes Pipeline Elements
 
-This project provides a library of several pipeline elements that can be used within the
StreamPipes toolbox.
-
-Currently, the following pipeline elements are available:
-
-**Data Sources**
-* Watertank Simulator: A data simulator that replays data from an Industrial IoT use case.
Several streams are provided such as flow rate, water level and more.
-* Vehicle Simulator: Provides a simulated stream that replays location-based real-time data
of a vehicle.
-* Random Data Generator: Several streams that produce randomly generated data in an endless
stream.
-
-**Data Processors**
-* Aggregation
-* Count Aggregation
-* Event Rate
-* Timestamp Enricher
-* Numerical Filter: Filters sensor values based on a configurable threshold value.
-* Text Filter: Filters text-based fields by a given string value.
-* Projection: Outputs a configurable subset of the fields available in an input event stream.
-* Geocoding
-* Google Routing
-* Increase
-* Peak Detection
-* Statistics Summary
-* Statistics Summary Window-Based
-* Field Converter
-* Field Hasher
-* Field Mapper
-* Measurement Unit Converter
-* Field Renamer
-
-
-**Data Sinks**
-* CouchDB: Stores events in an Apache CouchDB database.
-* Dashboard: Can be used to display pipeline results in the real-time dashboard of the StreamPipes
UI.
-* Kafka Publisher: Publishes events to an Apache Kafka broker.
-* Notification: Can be used to generate notifications that are shown in the notification
center of the StreamPipes UI.
-* JMS
-* RabbitMQ
-* Elasticsearch
-* Dashboard
-* Notification
-* Email Notification
-* Slack Notification
-* OneSignal Notification
+This project provides a library of several pipeline elements that can be used within the
Apache StreamPipes toolbox.
+
+See [https://streampipes.apache.org/docs/docs/pipeline-elements/](https://streampipes.apache.org/docs/docs/pipeline-elements/)

+for an overview of currently available pipeline elements.
 
 Contact us if you are missing some pipeline elements!
 
 ### Getting started
 
-All modules contain a docker-compose template in the `deployment` folder of each module.
Copy this into your StreamPipes docker-compose file (see the docs for more info) and start
StreamPipes! All pipeline elements are automatically registered (but do not forget to install
them under `Pipeline Element Installation`).
+See the installation guide at [https://streampipes.apache.org/download.html](https://streampipes.apache.org/download.html)
 
 It's easy to get started:
-* Download the installer script from [https://github.com/streampipes/streampipes-installer](https://github.com/streampipes/streampipes-installer)
-* Follow the installation guide at [https://docs.streampipes.org/docs/user-guide-installation](https://docs.streampipes.org/docs/user-guide-installation)
-* Check the [tour](https://docs.streampipes.org/docs/user-guide-tour) and build your first
pipeline!
+* Download the installer script from [https://github.com/apache/incubator-streampipes-installer](https://github.com/apache/incubator-streampipes-installer)
+* Follow the installation guide at [https://streampipes.apache.org/docs/docs/user-guide-installation](https://streampipes.apache.org/docs/docs/user-guide-installation)
+* Check the [tour](https://streampipes.apache.org/docs/docs/user-guide-tour) and build your
first pipeline!
+
+## Get help
+
+If you have any problems during the installation or questions around StreamPipes, you'll
get help through one of our 
+community channels:
+
+- [Slack](https://slack.streampipes.org)
+- [Mailing Lists](https://streampipes.apache.org/mailinglists.html)
+
+And don't forget to follow us on [Twitter](https://twitter.com/streampipes)!
 
-### Feedback
+## Contribute
 
-We'd love to hear your feedback! Contact us at [feedback@streampipes.org](mailto:feedback@streampipes.org)
+We welcome contributions to StreamPipes. If you are interested in contributing to StreamPipes,
let us know (e.g
+., send an email to the dev list)!
 


Mime
View raw message