Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sadikovi committed Jan 30, 2016
1 parent 1a22ac1 commit 96c3c7d
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@ A library for reading NetFlow files from [Spark SQL](http://spark.apache.org/doc
[![Build Status](https://travis-ci.org/sadikovi/spark-netflow.svg?branch=master)](https://travis-ci.org/sadikovi/spark-netflow)
[![codecov.io](https://codecov.io/github/sadikovi/spark-netflow/coverage.svg?branch=master)](https://codecov.io/github/sadikovi/spark-netflow?branch=master)

## Requirements
| Spark version | spark-netflow version |
|---------------|-----------------------|
| 1.4+ | [0.0.2](http://spark-packages.org/package/sadikovi/spark-netflow) |

## Linking
The spark-netflow library can be added to Spark by using the `--packages` command line option. For
example, run this to include it when starting the spark shell:
```shell
$SPARK_HOME/bin/spark-shell --packages sadikovi:spark-netflow:0.0.1-s_2.10
$SPARK_HOME/bin/spark-shell --packages sadikovi:spark-netflow:0.0.2-s_2.10
```

## Features
Expand All @@ -20,8 +25,8 @@ Currently supported options:
| Name | Example | Description |
|------|:-------:|-------------|
| `version` | _5_ | version to use when parsing NetFlow files
| `buffer` | _1024, 32Kb, 3Mb, etc_ | buffer size (in bytes) for NetFlow compressed stream
| `stringify` | _true, false_ | convert certain fields (e.g. IP) into human-readable format
| `buffer` | _1024, 32Kb, 3Mb, etc_ | buffer size for NetFlow compressed stream (default: 3Mb)
| `stringify` | _true, false_ | convert certain fields (e.g. IP) into human-readable format (default: false)

## Example

Expand Down

0 comments on commit 96c3c7d

Please sign in to comment.