Refine README and installation copy

[Syati]

Summary

• simplify the README introduction and make supported Rails/Ruby versions explicit
• tighten the Japanese README wording to match the English README more closely
• clarify why type registration is explicit in installation docs and improve gemspec metadata

Testing

• not run

Summary by CodeRabbit

• Documentation
  • Refined product descriptions and clarified Ruby/Rails support.
  • Updated Quick Start instructions for registering built-in structured types.
  • Added guidance for Rails initializer setup, optional type registration, and custom type names.
  • Improved API and form object examples, formatting, links, and explanatory notes.
  • Updated Japanese documentation to reflect the same guidance and terminology.
• Chores
  • Improved gem metadata with a clearer summary and detailed description of supported features.

[coderabbitai]

Warning

Review limit reached

@Syati, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 27 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8c4ad41a-4216-4521-87a7-1ad236ad8aaf

📥 Commits

Reviewing files that changed from the base of the PR and between 9a58656 and bf94ee0.

📒 Files selected for processing (6)

• .codex/config.toml
• .ruby-version
• README.md
• README_ja.md
• spec/params_spec.rb
• structured_params.gemspec

📝 Walkthrough

Walkthrough

The changes update English and Japanese documentation with revised product support details, registration terminology, installation guidance, example formatting, and link text. Gem metadata now includes a revised summary and a non-empty description.

Changes

Documentation and metadata

Layer / File(s)	Summary
Product documentation and examples README.md, README_ja.md	README content, quick-start labels, code-example formatting, links, and licensing text are updated.
Structured type registration guidance docs/installation.md	Installation guidance explains explicit built-in type registration, configuration ordering, lookup behavior, and custom names.
Gem specification metadata structured_params.gemspec	The gem summary is revised and the previously empty description now documents the package’s typed objects and validation integrations.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title is concise and accurately summarizes the main documentation-focused changes in the PR.
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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch update-readme

---

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

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@structured_params.gemspec`:
- Line 13: Reformat the gemspec description assigned to spec.description by
splitting the long string into adjacent concatenated string segments, keeping
each source line within RuboCop’s 120-character limit while preserving the exact
description text.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: eb179b62-267e-4d6c-970e-83c739134b6f

📥 Commits

Reviewing files that changed from the base of the PR and between 76c906f and 9a58656.

📒 Files selected for processing (4)

• README.md
• README_ja.md
• docs/installation.md
• structured_params.gemspec

[Copilot]

Pull request overview

This PR refines public-facing documentation and gem metadata to better describe StructuredParams’ purpose, explicitly state supported Ruby/Rails versions, and explain why ActiveModel type registration is opt-in.

Changes:

• Updated gemspec summary/description copy to be more descriptive and aligned with current features.
• Refreshed English/Japanese READMEs (intro wording, supported versions statement, and copy tightening).
• Expanded docs/installation.md to justify explicit register_types and to mention custom alias registration.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.

File	Description
structured_params.gemspec	Improve gem metadata summary/description.
README.md	Refine intro + supported versions; adjust installation snippet wording.
README_ja.md	Align Japanese README wording with English; minor phrasing tweaks.
docs/installation.md	Clarify explicit type registration rationale and custom alias guidance.