Skip to content

README install path & adapter status are misleading #1

@devblac

Description

@devblac

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

  • README and docs/QuickStart.md use the module path from go.mod in all install snippets.
  • Adapter section clearly marks incomplete/placeholder adapters (e.g., gRPC) and highlights working ones.
  • Links or references to current adapter examples are present.
     

Hints

Check README.md, docs/QuickStart.md, and go.mod for the current module path.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationgood first issueGood for newcomers

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions