Add description of bad rows and how to work with new bad rows in the README

[benjben]

Can be taken from the blog post

[chuwy]

Do you mean in docs or README or just in ScalaDoc?

[benjben]

I was thinking in the README but actually maybe we should just use sbt-ghpages and have all the information only in the Scaladoc.

[arthur78]

Hi guys. Are there any examples on how to use this library?

I'm checking the latest enricher and its (new) format of bad events. I took an example bad event and see it contains the alike piece of json:

"failure": { "timestamp": "2021-11-22T20:29:17.348772Z", "messages": [ { "schemaKey": "iglu:com.xxx/ui_event/jsonschema/2-0-128", "error": { "error": "ValidationError", "dataReports": [ { "message": "$.field1: does not have a value in the enumeration [option1, ...]", "path": "$.field1", "keyword": "enum", "targets": [ "[option1, ...]" ] } ] } } ] }

I understand that the provided value for that field1 is not within the list of permitted options defined by the schema, but is there an easy way for me to see the actual value provided? Can tasks like this be facilitated by that your library?

Thank you.