docs: deprecate package in favor of niels-numbers/laravel-localizer

[niels-numbers]

Heads-up @mcamara - pre-built per our LinkedIn DM today.

Two changes:

1. README: deprecation note at the top, pointing to niels-numbers/laravel-localizer
2. composer.json: standard abandoned field - Composer will show users a deprecation warning on composer install / composer update

The abandoned field is the official Composer mechanism to redirect existing users at install time, so it complements the README note nicely.

Wording, tone and placement are all open - feel free to adjust anything you'd like, or merge as-is. No rush from my end.

If you'd prefer a softer tone (e.g. "Active development has moved to..." instead of "no longer actively maintained"), happy to revise.

Thanks again for the goodwill - much appreciated.

Background: The successor package grew out of #921 and my appraoch to fix it in #934, where I started a v3.x rewrite of this package - but it became clear pretty quickly that the legacy constraints made it easier to start from scratch than to refactor in place.

Summary by CodeRabbit

• Documentation

  • Updated README with deprecation notice and migration guidance, directing users to the successor package featuring a from-scratch rebuild with compatible functionality.

• Chores

  • Marked package as abandoned in package metadata.

[coderabbitai]

Walkthrough

The package is marked as abandoned in composer.json metadata and the README is updated with a prominent deprecation notice directing users to the successor package niels-numbers/laravel-localizer, described as a from-scratch rebuild with specific compatibility fixes.

Changes

Cohort / File(s)	Summary
Package Deprecation Notice README.md	Added deprecation warning stating the original package is not actively maintained and directing users to migrate to niels-numbers/laravel-localizer successor package.
Package Metadata composer.json	Added abandoned field marking package as abandoned and pointing to the successor package.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A package once bright, now passes the torch,
To laravel-localizer, a fresh rebuild to scorch,
The README now whispers, "Come follow this way,"
While composer.json marks our final day,
We rest with a smile, our mission is done! 🌙

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely summarizes the main change: marking the package as deprecated in favor of an alternative package by adding documentation and metadata updates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

📝 Generate docstrings

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/deprecation-notice

---

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.}

[coderabbitai]

🧹 Nitpick comments (1)

README.md (1)

9-21: ⚡ Quick win

Consider clarifying the ongoing maintenance policy.

While the notice clearly states the package is "no longer actively maintained," you might want to explicitly mention whether critical security fixes will still be applied or if all maintenance has ceased entirely. This helps existing users assess risk.

For example, you could add a line like:

Note: This package will receive critical security fixes only until [date], after which no further updates will be provided.

Or if maintenance has completely stopped:

Note: This package is no longer receiving updates, including security fixes.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 9 - 21, Update the maintenance notice that begins
"**This package is no longer actively maintained.**" in README.md to explicitly
state the security/maintenance policy; add a single-line "Note:" immediately
after that paragraph clarifying whether critical security fixes will be provided
(and until what date) or that no further updates, including security fixes, will
be made, and keep the wording concise and factual so users can quickly assess
risk.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Around line 9-21: Update the maintenance notice that begins "**This package is
no longer actively maintained.**" in README.md to explicitly state the
security/maintenance policy; add a single-line "Note:" immediately after that
paragraph clarifying whether critical security fixes will be provided (and until
what date) or that no further updates, including security fixes, will be made,
and keep the wording concise and factual so users can quickly assess risk.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 33e4f5d6-0a04-48c5-ae9d-88ee5230630c

📥 Commits

Reviewing files that changed from the base of the PR and between b4b530b and d140a8d.

📒 Files selected for processing (2)

• README.md
• composer.json

[mcamara]

Thanks @niels-numbers for your help all these years and good luck with the new package!

PS: I really liked coderabbit's poem about this PR 😄