Create documentation and fix release

[Smoss]

Change Type

• New Feature
• Bugfix
• Chore
• Breaking Change

Description

Describe changes here

Summary by CodeRabbit

• Documentation

  • Added comprehensive guide covering GORMful installation, CLI usage, library integration, migration examples, and tracking behavior with code samples and database setup instructions.

• Chores

  • Updated module path configuration.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request updates the module path from github.com/GORMful to github.com/smoss/GORMful across configuration and source files, adds a comprehensive README documenting installation and usage, and introduces a migration model initialization function.

Changes

Cohort / File(s)	Summary
Module Path Update go.mod	Updated module declaration from github.com/GORMful to github.com/smoss/GORMful
Import Path Updates cmd/GORMful/main.go, models/MigrationTemplate.go	Updated import paths to reflect new module namespace github.com/smoss/GORMful/models
Migration Model Initialization cmd/GORMful/main.go	Added createMigrationModel() function that calls db.AutoMigrate(&models.MigrationModel{}) to initialize migration tracking
Documentation README.md	Added comprehensive README covering installation, CLI usage, environment variables, command-line flags, generated migration structure, library usage examples, and migration tracking behavior

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A namespace shift, so swift and clean,
From GORMful to smoss, our new regime!
With README bright and models in place,
This project now shows its graceful face. ✨

✨ Finishing touches

• 📝 Generate docstrings

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between da5cc77 and 8bce505.

📒 Files selected for processing (4)

• README.md
• cmd/GORMful/main.go
• go.mod
• models/MigrationTemplate.go

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}