avro-to-markdown 0.2.0

Create markdown documentation from an avro schema.

Avro to Markdown

About The Project

Avro to markdown is a very simple project that generates readable markdown from an avro schema. This is useful to be able to generate readable, always up-to-date documentation on the schemas you use to exchange messages within your organization.

Getting Started

To get a local copy up and running follow these simple steps.

Installation

1. Clone the repo

   git clone https://github.com/wayfair-incubator/avro-to-markdown.git
   

2. Install package

   pip install avro-to-markdown
   

Usage

...

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. For detailed contributing guidelines, please see CONTRIBUTING.md

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Colm O'Connor

Project Link: https://github.com/wayfair-incubator/avro-to-markdown/

Acknowledgements

This template adapted from https://github.com/othneildrew/Best-README-Template