docs: rewrite README with complete Quick Start guide#26
Open
AWaterColorPen wants to merge 1 commit intomainfrom
Open
docs: rewrite README with complete Quick Start guide#26AWaterColorPen wants to merge 1 commit intomainfrom
AWaterColorPen wants to merge 1 commit intomainfrom
Conversation
- Add badges (Go CI, pkg.go.dev) - Replace sparse Getting Started with step-by-step Quick Start: - go get install instruction - TOML dictionary config example (article feature) - Register[T] generic type setup - Service creation with SQLite - Domain + superadmin bootstrap - Role assignment and permission check - CurrentService scoped usage - playground package for testing - Add storage backends table (sqlite/mysql/postgres) - Add Redis watcher configuration example - Fix WatcherOption fields (Type + Address) to match actual struct - Remove inaccurate SQL Server reference (not in metadata_database.go) Phase 1 task: 完善 README Quick Start
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
变更说明
这是 caskin 现代化迭代 Phase 1 的 README Quick Start 任务。
改动内容
全面重写 README,补充真实可运行的 Quick Start 示例:
go get安装caskin.Register[T]泛型类型注册CurrentService用法playground包的测试用法说明WatcherOption字段(Type+Address)与实际结构体一致metadata_database.go中未实现)Phase 1 进度
slices/cmp替换golang.org/x/expgo-linq