Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sonsoleslp committed Nov 29, 2018
1 parent 0b5759c commit 5160819
Showing 1 changed file with 21 additions and 8 deletions.
29 changes: 21 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,20 @@
The Cosmos Generic Enabler enables an easier BigData analysis over context
integrated with some of the most popular BigData platforms.

### WHAT IS COSMOS?

## Content

- [WHAT IS COSMOS?](#what-is-cosmos)
- [WHY USE COSMOS?](#why-use-cosmos)
- [Orion Flink Connector](#orion-flink-connector)
- [Installation](#installation)
- [Usage](#usage)
- [Production](#production)
- [Quality Assurance](#quality-assurance)
- [License](#license)


## WHAT IS COSMOS?

The Cosmos BigData Analysis GE is a set of tools that help achieving the tasks
of Streaming and Batch processing over context data. These tools are:
Expand All @@ -20,7 +33,7 @@ of Streaming and Batch processing over context data. These tools are:
- Apache Spark Processing Engine (work in progress)
- Streaming processing examples using Orion Context Broker

### WHY USE COSMOS?
## WHY USE COSMOS?

As the state of the real world changes, the entities representing your IoT
devices are constantly changing. Big data analysis allows for the study of
Expand All @@ -29,7 +42,7 @@ data-processing software. You can apply predictive analysis or user behaviour
analytics to extract meaningful conclusions as to the state of your smart
solution and bring value to your solution.

### Orion Flink Connector
## Orion Flink Connector

This is a Flink connector for the Fiware Orion Context Broker. It has two parts:

Expand All @@ -41,7 +54,7 @@ Several examples are provided to facilitate getting started with the connector.
They are hosted in a separate repository:
[fiware-cosmos-orion-flink-connector-examples](https://github.com/ging/fiware-cosmos-orion-flink-connector-examples).

## Installation
### Installation

Download the JAR from the latest release. In your project directory run:

Expand All @@ -59,9 +72,9 @@ Add it to your `pom.xml` file inside the dependencies section.
</dependency>
```

## Usage
### Usage

### OrionSource
#### OrionSource

- Import dependency.

Expand Down Expand Up @@ -100,7 +113,7 @@ Add it to your `pom.xml` file inside the dependencies section.
- **`value`**: Value of the attribute.
- **`metadata`**: Additional metadata.

### OrionSink
#### OrionSink

- Import dependency.

Expand Down Expand Up @@ -131,7 +144,7 @@ val processedDataStream = eventStream. // ...
- **`method`**: HTTP method of the message. It can be `HTTPMethod.POST`,
`HTTPMethod.PUT` or `HTTPMethod.PATCH`.

## Production
### Production

> **Warning** :warning:
>
Expand Down

0 comments on commit 5160819

Please sign in to comment.