From a6c82b36a8a420ff6a7b4f9203e1d934e575c772 Mon Sep 17 00:00:00 2001
From: stewartboyd119 <stewartboyd1988@gmail.com>
Date: Mon, 22 Jul 2024 15:07:02 -0700
Subject: [PATCH] Updated README.md (#3)

Updated README.md
---
 .gitignore |  1 +
 README.md  | 24 +++---------------------
 2 files changed, 4 insertions(+), 21 deletions(-)

diff --git a/.gitignore b/.gitignore
index 3bb8d19..1aa85e8 100644
--- a/.gitignore
+++ b/.gitignore
@@ -48,3 +48,4 @@ liquibase.properties
 coverage.txt
 cover.out
 cover.html
+codecov
diff --git a/README.md b/README.md
index 08f309e..bff40b4 100644
--- a/README.md
+++ b/README.md
@@ -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.
\ No newline at end of file
+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.