Skip to content

Commit

Permalink
Updated README.md (#3)
Browse files Browse the repository at this point in the history
Updated README.md
  • Loading branch information
stewartboyd119 authored Jul 22, 2024
1 parent ab0f32c commit a6c82b3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 21 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,4 @@ liquibase.properties
coverage.txt
cover.out
cover.html
codecov
24 changes: 3 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,6 @@
[![GitHub Actions](https://github.com/zillow/zfmt/actions/workflows/go.yml/badge.svg)](https://github.com/zillow/zfmt/actions/workflows/go.yml)
[![Codecov](https://codecov.io/gh/zillow/zfmt/branch/main/graph/badge.svg?token=STRT8T67YP)](https://codecov.io/gh/zillow/zfmt)


A go library which contains a number of useful implementations of the Formatter interface,
an interface which contains Marshall and Unmarshall methods.

## Dependencies

### Gogen Avro

Install [Gogen Avro](https://github.com/actgardner/gogen-avro) a utility for generating go code from avro schemas (used for testdata)

```
go get github.com/actgardner/gogen-avro/v7/cmd/...
```


### Migration Guide

1. #### V0 to V1 Migration

* Enum `ProtoFmt`(`proto`) renamed to `ProtoBase64Fmt`(`proto_base64`). This is intended for SQS use only while the newly introduced `ProtoRawFmt`(`proto_raw`) is intended for most other use cases.
* Enum `ProtoSchemaFmt`(`proto_schema`) renamed to `ProtoSchemaDeprecatedFmt`(`proto_schema_deprecated`). The proto schema is deprecated because it doesn't work properly with the confluent schema registry. Use the `ProtoRawFmt` or `ProtoBase64Fmt` instead.
A module which defines several concrete `Formatter` types responsible for serializing/deserializing objects.
The module centralizes this functionality and is leveraged by several zillow transport libs for use in configuration
driven serialization.

0 comments on commit a6c82b3

Please sign in to comment.