Skip to content

docs: Update README for SilverStripe 6#18

Merged
jsirish merged 2 commits into3from
3.0/readme-update
Nov 18, 2025
Merged

docs: Update README for SilverStripe 6#18
jsirish merged 2 commits into3from
3.0/readme-update

Conversation

@jsirish
Copy link
Copy Markdown
Member

@jsirish jsirish commented Nov 18, 2025

Updates README documentation following the SS6 upgrade to version 3.0.

Changes

  • Add PHP requirement ^8.1
  • Update SilverStripe requirement to ^6
  • Add standardized GitHub Sponsors badge
  • Remove unstable version badge
  • Add comprehensive Features section:
    • Country Dropdown field
    • Intl Integration
    • Customizable source
    • Form field extension
  • Add upgrade notes for v2→v3 migration
  • Add SilverStripe 6 upgrade guide reference

This completes the documentation updates for the v3.0 SS6 release.

- Add PHP requirement ^8.1
- Update SilverStripe requirement to ^6
- Add GitHub Sponsors badge (standardized format)
- Remove unstable version badge
- Add Features section (4 key features)
- Add upgrade notes for v2→v3 migration
- Add SilverStripe 6 upgrade guide reference
@jsirish jsirish changed the base branch from master to 3 November 18, 2025 19:40
@jsirish jsirish requested a review from Copilot November 18, 2025 19:41
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the README documentation to reflect the upgrade to SilverStripe 6 for the 3.0 release of the Country Dropdown Field module.

  • Updated system requirements to PHP ^8.1 and SilverStripe ^6
  • Added comprehensive Features section documenting the module's capabilities
  • Included upgrade notes for users migrating from version 2.x
  • Enhanced badges with standardized GitHub Sponsors badge and removed unstable version badge

Reviewed Changes

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

File Description
composer.json Removed obsolete branch-alias configuration from the extra section
README.md Updated requirements, added Features section, added upgrade notes for v2→v3 migration, updated sponsor badge, and removed unstable version badge

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@jsirish jsirish merged commit 1099556 into 3 Nov 18, 2025
22 checks passed
@jsirish jsirish deleted the 3.0/readme-update branch November 18, 2025 19:44
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.

2 participants