Skip to content

feat: update README to reflect addition of NATS RPC and enhance domain descriptions#407

Merged
soltanoff merged 1 commit intomasterfrom
feat/upd-readme
Apr 5, 2026
Merged

feat: update README to reflect addition of NATS RPC and enhance domain descriptions#407
soltanoff merged 1 commit intomasterfrom
feat/upd-readme

Conversation

@soltanoff
Copy link
Copy Markdown
Collaborator

This pull request updates the documentation in all three main language variants (README.md, README_CN.md, and README_RU.md) to clarify and expand on the available server types and supported domains in the Go Clean Template project. It also improves the accuracy of the architecture explanations and updates example code to match the current API. The changes ensure consistency across the English, Chinese, and Russian documentation.

Key documentation improvements:

Server types and supported domains:

  • Updated all READMEs to state that the template implements four server types (REST, gRPC, AMQP RPC, NATS RPC), instead of three. [1] [2] [3]
  • Added detailed sections describing the three fully implemented domains (User Authentication, Task Management, Translation) and their availability across all four transports, with operation tables and feature lists. [1] [2] [3]

Example code and usage updates:

  • Updated example router code snippets to use unified v1.NewRoutes and v2.NewRoutes functions, reflecting the current API and reducing boilerplate in all controller types (REST, gRPC, AMQP RPC, NATS RPC). [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]

Architecture and terminology corrections:

  • Clarified the location and naming of infrastructure packages, changing references from internal/usecase/repo and internal/usecase/webapi to internal/repo/persistent and internal/repo/webapi, and updated the explanation of the infrastructure layer accordingly. [1] [2] [3]
  • Updated the recommended mocking tool from mockery to go.uber.org/mock for auto-generating mocks in all language variants. [1] [2] [3]

These changes bring the documentation up to date with the current codebase, improve clarity for new users, and ensure consistency across all supported languages.

@soltanoff soltanoff self-assigned this Apr 5, 2026
@soltanoff soltanoff added the documentation Improvements or additions to documentation label Apr 5, 2026
@soltanoff soltanoff merged commit e72f455 into master Apr 5, 2026
7 checks passed
@soltanoff soltanoff deleted the feat/upd-readme branch April 5, 2026 21:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant