Skip to content

docs(readme): refresh for 0.9.0 / 0.9.1#71

Merged
Mx-Iris merged 1 commit intomainfrom
docs/readme-0.9.1
Apr 19, 2026
Merged

docs(readme): refresh for 0.9.0 / 0.9.1#71
Mx-Iris merged 1 commit intomainfrom
docs/readme-0.9.1

Conversation

@Mx-Iris
Copy link
Copy Markdown
Member

@Mx-Iris Mx-Iris commented Apr 19, 2026

Summary

  • Add Requirements section (Swift 6.2+, Xcode 26.0+, platform minimums).
  • Mark Swift Interface Support and Runtime Metadata Inspection as completed in the roadmap.
  • Add SPM integration snippet and a table describing the five published library products.
  • Describe the SwiftInspection utilities (EnumLayoutCalculator, ClassHierarchyDumper, MetadataReader), including the @_spi(Internals) caveat for ClassHierarchyDumper.
  • Document 0.9.0 SwiftInterface coverage (attributes, distributed actors, deinit, VTable offsets, expanded field offsets, inverted protocols) and dump annotations (PWT entries / addresses, inverted constraints).
  • Call out the 0.9.0 breaking change: --architecture is required for fat / universal binaries.

Test plan

  • No code change; visual review of rendered README on the PR page

- Add Requirements section (Swift 6.2+, Xcode 26.0+, platform minimums)
- Mark Swift Interface Support and Runtime Metadata Inspection as
  completed items in the roadmap
- Add Swift Package Manager integration snippet plus a table of the
  five published library products
- Describe SwiftInspection utilities (EnumLayoutCalculator,
  ClassHierarchyDumper, MetadataReader) and note ClassHierarchyDumper
  requires @_spi(Internals)
- Document the 0.9.0 SwiftInterface coverage: attributes, distributed
  actors, deinit, VTable offsets, expanded field offsets, inverted
  protocols
- Document the 0.9.0 dump annotations: PWT entries, inverted protocol
  constraints, PWT addresses
- Call out the 0.9.0 breaking change: --architecture is now required
  for fat / universal binaries
Copilot AI review requested due to automatic review settings April 19, 2026 11:23
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the README.md to include system requirements, Swift Package Manager installation instructions, and detailed documentation for the SwiftInspection library and CLI tool. It also adds important notes regarding mandatory architecture flags for fat binaries in the CLI. A correction was suggested for the Xcode version requirement, which likely contains a typo (26.0+ instead of 16.0+).

Comment thread README.md
## Requirements

- Swift 6.2+
- Xcode 26.0+
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

The Xcode version 26.0+ appears to be a typo for 16.0+. Xcode 16 is the current major version that introduced Swift 6 support. If you specifically mean a version that supports Swift 6.2, it would likely be a later point release of Xcode 16 (e.g., 16.3) or Xcode 17.

Suggested change
- Xcode 26.0+
- Xcode 16.0+

Copy link
Copy Markdown
Contributor

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

Updates the repository README to reflect the 0.9.0 / 0.9.1 releases, aligning the public docs with the current SwiftPM manifest, feature set, and CLI behavior.

Changes:

  • Adds a Requirements section (Swift/Xcode versions and platform minimums) and refreshes the roadmap status.
  • Documents SwiftPM integration and the five published library products, including SwiftInspection utilities and SPI caveats.
  • Expands CLI and interface-generation documentation, including the 0.9.0 breaking change requiring --architecture for fat/universal binaries.

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

@Mx-Iris Mx-Iris merged commit 5011536 into main Apr 19, 2026
5 checks passed
@Mx-Iris Mx-Iris deleted the docs/readme-0.9.1 branch April 19, 2026 11:45
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