Update README

[dveeden]

• More clearly state that this should also work for MariaDB
• Move migration info to the end of the README as there are probably not that many people anymore that need this
• Add a go mod edit -replace to the migration section
• Add more details to the "Content" section
• List examples
• Add a Go Reference badge
• Improve the info about GTID in the replication example
• Remove the donate and feedback sections
• Add credits section

Open questions:

• Should we update the "Donate" and "Feedback" sections?
• Should the examples be listed next to the sections in the README or combined in a single section? My preferences is combined.
• Should we link to https://github.com/go-mysql-org/go-mysql-elasticsearch ? It hasn't been maintained for a while.

[lance6716]

Should we update the "Donate" and "Feedback" sections?

I think @siddontang does not need donation from this project now 😄 We can setup our donation link but I'm not familiar with it. For feedback I guess most users of this package are golang developers and they can open GitHub issues without the feedback guide

Should the examples be listed next to the sections in the README or combined in a single section

The simple program under /cmd should also be helpful to new developers, I think we can only leave very short code snippet in README and link to /cmd for a more detailed usage. I'll think about this part later.

[dveeden]

@lance6716 GitHub offers this: https://github.com/sponsors but not sure if that's only for individuals or also for organizations. I'm not sure we need this.

[lance6716]

@lance6716 GitHub offers this: https://github.com/sponsors but not sure if that's only for individuals or also for organizations. I'm not sure we need this.

I checked that organization can have sponsors, but it requires an email as contact and a bank account 😂 It seems more suitable for a real organization rather than our virtual team. I'm not capable to handle these finance stuffs, maybe you or other organization members can handle this or we don't need sponsors for now.

I'll review README changes soon.

[lance6716]

rest lgtm

[lance6716]

IMO the difference between this "Incremental dumping" and "Replication" item are developers need to implement interfaces (like EventHandler) or handle decoded binlog events. Maybe use "library mode" or "framework mode". I choose these two words to tell the difference like

When you use a library, you are in charge of the flow of the application. You are choosing when and where to call the library. When you use a framework, the framework is in charge of the flow. It provides some places for you to plug in your code, but it calls the code you plugged in as needed.

https://www.freecodecamp.org/news/the-difference-between-a-framework-and-a-library-bd133054023f/ (a random blog ranks top in google search "library vs framework")

[dveeden]

Not sure what you want me to change. Do you you want to clarify the difference between "Replication" and "Incremental dumping"?

[lance6716]

yes, like

* [Use as a library](#replication) - Process events from a binlog stream and have maximum functionalities.
* [Use as a framework](#canal) - Implement `EventHandler` interface to subscribe binlog changes

[lance6716]

However I don't have confidence how to describe these two items. Will think about it later

[lance6716]

In fact I don't know what's canal 😂 maybe it's https://github.com/alibaba/canal?tab=readme-ov-file ? I'm not sure this library will output similar output or have similar usage as that one.

[dveeden]

Looks like it might be similar, but I'm not sure it is the same or if it is compatible.