Skip to content

Commit

Permalink
documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Rafal Kluszczynski committed Jan 3, 2017
1 parent 4cfe16a commit 13d49b1
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 1 deletion.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@
[![Build Status](https://travis-ci.org/rkluszczynski/avro-cli.svg?branch=master)](https://travis-ci.org/rkluszczynski/avro-cli)
[![Coverage Status](https://coveralls.io/repos/github/rkluszczynski/avro-cli/badge.svg?branch=master)](https://coveralls.io/github/rkluszczynski/avro-cli?branch=master)
[![Documentation Status](https://readthedocs.org/projects/avro-cli/badge/?version=latest)](http://avro-cli.readthedocs.io/en/latest/?badge=latest)

Curious? See documentation: http://avro-cli.readthedocs.io ;)
46 changes: 45 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,48 @@
avro-cli
========

TODO
# Quickstart

To see usage, you need to have Java 8 installed. Then just download latest release and type:

```bash
java -jar avro-cli-X.X.X.jar
```

where X.X.X stands for version.

# Commands

## Native Avro validation

```
Usage: validate [options]
Options:
--compatibility, -c
One of compatibility strategy.
Default: FULL
Possible Values: [BACKWARD, FORWARD, FULL]
--latest, -l
Use only latest validator.
Default: false
--previousSchemaFile, -p
Sources of previous schemas in order of appearance in command line.
Default: []
* --schemaFile, -f
Source of schema to read.
```

Example of usage:

```bash
java -jar avro-cli-X.X.X.jar validate -c backward -f schema2-string-null-field.json -p schema1-string-field.json
```

where files can bee seen [here](https://github.com/rkluszczynski/avro-cli/tree/master/src/test/resources/validation).

# Credits

* [Apache Avro™ 1.8.1 Specification](http://avro.apache.org/docs/1.8.1/spec.html)
* [Spring boot](https://projects.spring.io/spring-boot)
* [JCommander](http://jcommander.org)

0 comments on commit 13d49b1

Please sign in to comment.