| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| # Welcome to Apache Flume Twitter! |
| |
| Apache Flume is a distributed, reliable, and available service for efficiently |
| collecting, aggregating, and moving large amounts of event data. It has a simple |
| and flexible architecture based on streaming data flows. It is robust and fault |
| tolerant with tunable reliability mechanisms and many failover and recovery |
| mechanisms. The system is centrally managed and allows for intelligent dynamic |
| management. It uses a simple extensible data model that allows for online |
| analytic application. |
| |
| The Apache Flume Twitter module provides a source to receive data from Twitter |
| |
| Apache Flume Twitter is open-sourced under the Apache Software Foundation License v2.0. |
| |
| ## Documentation |
| |
| Documentation is included in the binary distribution under the docs directory. |
| In source form, it can be found in the flume-ng-doc directory. |
| |
| The Flume 1.x guide and FAQ are available here: |
| |
| * https://cwiki.apache.org/FLUME |
| * https://cwiki.apache.org/confluence/display/FLUME/Getting+Started |
| |
| ## Contact us! |
| |
| * Mailing lists: https://cwiki.apache.org/confluence/display/FLUME/Mailing+Lists |
| * Slack channel #flume on https://the-asf.slack.com/ |
| |
| Bug and Issue tracker. |
| |
| * https://github.com/apache/flume-twitter/issues |
| |
| ## Compiling Flume Twitter |
| |
| Compiling Flume Twitter requires the following tools: |
| |
| * Oracle Java JDK 11 |
| * Apache Maven 3.x |
