Update README #950
Update README #950
Conversation
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
The simple program under |
|
@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. |
| * [Fake server](#server) | ||
| * [database/sql like driver](#driver) | ||
| * [Replication](#replication) - Process events from a binlog stream. | ||
| * [Incremental dumping](#canal) - Sync from MySQL to Redis, Elasticsearch, etc. |
There was a problem hiding this comment.
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")
There was a problem hiding this comment.
Not sure what you want me to change. Do you you want to clarify the difference between "Replication" and "Incremental dumping"?
There was a problem hiding this comment.
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
There was a problem hiding this comment.
However I don't have confidence how to describe these two items. Will think about it later
| The `cmd` directory contains example applications that can be build by running `make build` in the root of the project. The resulting binaries will be places in `bin/`. | ||
|
|
||
| - `go-binlogparser`: parses a binlog file at a given offset | ||
| - `go-canal`: streams binlog events from a server to canal |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Looks like it might be similar, but I'm not sure it is the same or if it is compatible.
|
Sorry I'm too busy this week and don't have enough time to check my comments. Because this PR definitely is an improvement, I think we can merge it. The unresolved comment can be fixed in future PR |
…_readme Signed-off-by: lance6716 <[email protected]>
go mod edit -replaceto the migration sectionGo ReferencebadgeOpen questions:
Should we update the "Donate" and "Feedback" sections?