Skip to content

Commit

Permalink
More documentation fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ngoyal committed Jun 8, 2015
1 parent 4b2763f commit 7e24c3a
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ A Python client used to interact with [Confluent](http://confluent.io/)'s

The API is heavily based off of the existing Java API of [Confluent schema registry](https://github.com/confluentinc/schema-registry).

# Installation

Run `python setup.py install` from the source root.

This library will be available via `pip` in the future.

# Example Usage

Expand Down Expand Up @@ -42,7 +47,7 @@ schema_version = client.get_version('my_subject', avro_schema)
is_compatible = client.test_compatibility('my_subject', another_schema)

# One of NONE, FULL, FORWARD, BACKWARD
new*level = client.update*compatibility('NONE','my_subject')
new_level = client.update*compatibility('NONE','my_subject')
current_level = client.get_compatibility('my_subject')

# Message operations
Expand Down

0 comments on commit 7e24c3a

Please sign in to comment.