Skip to content

chore: update dependencies and refactor README with architecture diagram#3

Closed
gjchentw wants to merge 2 commits intoginmills:masterfrom
gjchentw:master
Closed

chore: update dependencies and refactor README with architecture diagram#3
gjchentw wants to merge 2 commits intoginmills:masterfrom
gjchentw:master

Conversation

@gjchentw
Copy link
Contributor

📝 Description

This PR updates the project dependencies to their latest versions and significantly improves the documentation to better explain the project's purpose and usage.

🛠️ Changes

📦 Dependencies

  • Bumped Go version to 1.24.0.
  • Updated github.com/gin-gonic/gin to v1.11.0.
  • Ran go mod tidy to ensure go.sum is up to date.

📚 Documentation (README.md)

  • Added Badges: Included status badges for CI, Go version, Go Reference, and License.
  • Clarified Goals: Updated the introduction to clearly state the "Write Once, Reuse Everywhere" philosophy.
  • Architecture Diagram: Added a Mermaid graph to visualize the relationship between Gin, Ginmill, and Feature packages (including a "ginmill" nod).
  • Improved Examples:
    • Added a basic "Cheers" example.
    • Refined the "Mastodon API" example to show advanced usage.

✅ Verification

  • Ran go test ./... - All tests passed.
  • Ran govulncheck ./... - No vulnerabilities found.

@gjchentw gjchentw marked this pull request as draft January 28, 2026 03:08
@gjchentw gjchentw marked this pull request as ready for review January 28, 2026 03:15
@gjchentw gjchentw closed this Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant