README install path & adapter status are misleading
Context
I tried to onboard a teammate and realized the README/QuickStart still tell folks to go get github.com/devblac/gamifykit even though the module path is just gamifykit. The docs also imply some adapters are production-ready when they’re still placeholders. This led to confusion before we even wrote a line of code.
Problem
Install commands don’t match go.mod, and the adapter list doesn’t flag incomplete pieces (e.g., gRPC). New users assume things work that aren’t implemented.
Expected behavior
Docs show the correct install path and call out which adapters are real vs. placeholders, with pointers to working examples.
Scope / non-goals
Don’t change code or adapter behavior—only fix docs and status notes. Keep it concise; no marketing copy.
Acceptance criteria
Hints
Check README.md, docs/QuickStart.md, and go.mod for the current module path.
README install path & adapter status are misleading
Context
I tried to onboard a teammate and realized the README/QuickStart still tell folks to
go get github.com/devblac/gamifykiteven though the module path is justgamifykit. The docs also imply some adapters are production-ready when they’re still placeholders. This led to confusion before we even wrote a line of code.Problem
Install commands don’t match
go.mod, and the adapter list doesn’t flag incomplete pieces (e.g., gRPC). New users assume things work that aren’t implemented.Expected behavior
Docs show the correct install path and call out which adapters are real vs. placeholders, with pointers to working examples.
Scope / non-goals
Don’t change code or adapter behavior—only fix docs and status notes. Keep it concise; no marketing copy.
Acceptance criteria
docs/QuickStart.mduse the module path fromgo.modin all install snippets.Hints
Check
README.md,docs/QuickStart.md, andgo.modfor the current module path.