aaron-ai commented on code in PR #19: URL: https://github.com/apache/rocketmq-clients/pull/19#discussion_r906834911
########## golang/README.md: ########## @@ -0,0 +1,38 @@ +Introduction +-------------- +Project github.com/apache/rocketmq-clients/golang is targeted to implement with golang. At the current moment, it is still a work-in-progress project. Do not use it in production till it grows mature enough. + +Architecture +-------------- +Basically, this project would follow the same paradigm of [rocketmq-client-cpp v5.0.0](https://github.com/apache/rocketmq-client-cpp/tree/main). Namely, we would build the whole client following protocols described in [rocketmq-apis](https://github.com/apache/rocketmq-apis) on top of [gRPC-go](https://github.com/grpc/grpc-go), utilizing [Protocol buffers](https://developers.google.com/protocol-buffers) to serialize and deserialize data in transmission. + + +How to use +----------------- + +#### Installation + +With [Go module][] support (Go 1.11+), simply add the following import + +```go +import "github.com/apache/rocketmq-clients/golang" +``` + +to your code, and then `go [build|run|test]` will automatically fetch the +necessary dependencies. Review Comment: Put the code block at the bottom. ```suggestion With [Go modules](https://go.dev/doc/go1.11#modules)(Go 1.11+), simply add the following import to your code, and then `go [build|run|test]` will automatically fetch the necessary dependencies. ```go import "github.com/apache/rocketmq-clients/golang" ``` ``` ########## golang/README.md: ########## @@ -0,0 +1,38 @@ +Introduction +-------------- +Project github.com/apache/rocketmq-clients/golang is targeted to implement with golang. At the current moment, it is still a work-in-progress project. Do not use it in production till it grows mature enough. + +Architecture +-------------- +Basically, this project would follow the same paradigm of [rocketmq-client-cpp v5.0.0](https://github.com/apache/rocketmq-client-cpp/tree/main). Namely, we would build the whole client following protocols described in [rocketmq-apis](https://github.com/apache/rocketmq-apis) on top of [gRPC-go](https://github.com/grpc/grpc-go), utilizing [Protocol buffers](https://developers.google.com/protocol-buffers) to serialize and deserialize data in transmission. Review Comment: ```suggestion We build the following protocols described in [rocketmq-apis](https://github.com/apache/rocketmq-apis) on top of [gRPC-go](https://github.com/grpc/grpc-go), utilizing [Protocol buffers](https://developers.google.com/protocol-buffers) to serialize and deserialize data in transmission. ``` ########## golang/README.md: ########## @@ -0,0 +1,38 @@ +Introduction +-------------- +Project github.com/apache/rocketmq-clients/golang is targeted to implement with golang. At the current moment, it is still a work-in-progress project. Do not use it in production till it grows mature enough. + +Architecture +-------------- +Basically, this project would follow the same paradigm of [rocketmq-client-cpp v5.0.0](https://github.com/apache/rocketmq-client-cpp/tree/main). Namely, we would build the whole client following protocols described in [rocketmq-apis](https://github.com/apache/rocketmq-apis) on top of [gRPC-go](https://github.com/grpc/grpc-go), utilizing [Protocol buffers](https://developers.google.com/protocol-buffers) to serialize and deserialize data in transmission. + + +How to use +----------------- + +#### Installation + +With [Go module][] support (Go 1.11+), simply add the following import + +```go +import "github.com/apache/rocketmq-clients/golang" +``` + +to your code, and then `go [build|run|test]` will automatically fetch the +necessary dependencies. + +Otherwise, to install the `golang` package, run the following command: + +```console +$ go get -u github.com/apache/rocketmq-clients/golang +``` + +License +------------------ +This project follows [Apache License Version 2.0](./LICENSE). Review Comment: duplicate with [README.md](https://github.com/apache/rocketmq-clients/blob/master/README.md) ########## golang/README.md: ########## @@ -0,0 +1,38 @@ +Introduction +-------------- +Project github.com/apache/rocketmq-clients/golang is targeted to implement with golang. At the current moment, it is still a work-in-progress project. Do not use it in production till it grows mature enough. + +Architecture +-------------- +Basically, this project would follow the same paradigm of [rocketmq-client-cpp v5.0.0](https://github.com/apache/rocketmq-client-cpp/tree/main). Namely, we would build the whole client following protocols described in [rocketmq-apis](https://github.com/apache/rocketmq-apis) on top of [gRPC-go](https://github.com/grpc/grpc-go), utilizing [Protocol buffers](https://developers.google.com/protocol-buffers) to serialize and deserialize data in transmission. + + +How to use +----------------- + +#### Installation + +With [Go module][] support (Go 1.11+), simply add the following import + +```go +import "github.com/apache/rocketmq-clients/golang" +``` + +to your code, and then `go [build|run|test]` will automatically fetch the +necessary dependencies. + +Otherwise, to install the `golang` package, run the following command: + +```console +$ go get -u github.com/apache/rocketmq-clients/golang +``` + +License +------------------ +This project follows [Apache License Version 2.0](./LICENSE). Review Comment: ```suggestion ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
