Skip to content

Update documentation and licensing for 2.2.0 release#32

Merged
mrbiggred merged 8 commits intorelease/2.2.0from
feature/update-documentation-for-2.2.0-release
Nov 13, 2025
Merged

Update documentation and licensing for 2.2.0 release#32
mrbiggred merged 8 commits intorelease/2.2.0from
feature/update-documentation-for-2.2.0-release

Conversation

@mrbiggred
Copy link
Copy Markdown
Member

Enhance project documentation, clarify installation steps, and update licensing information. Move AI instructions to a dedicated file for better organization.

@mrbiggred mrbiggred requested a review from Copilot November 13, 2025 17:38
@mrbiggred mrbiggred self-assigned this Nov 13, 2025
@mrbiggred mrbiggred added the documentation Improvements or additions to documentation label Nov 13, 2025
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 pull request updates the project documentation and licensing for the 2.2.0 release, focusing on enhancing clarity and organization of project information.

Key Changes:

  • Enhanced README.md with detailed installation instructions for Swift Package Manager and XCFramework, plus comprehensive usage examples for both Swift and Objective-C
  • Reorganized AI assistant instructions by moving content from CLAUDE.md to a vendor-neutral AGENTS.md file
  • Updated LICENSE to include Saturday Morning Productions Inc. copyright

Reviewed Changes

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

Show a summary per file
File Description
README.md Significantly expanded with detailed installation steps, building instructions, comprehensive code examples for Swift and Objective-C, and enhanced documentation structure
LICENSE Added copyright line for Saturday Morning Productions Inc. (2023) alongside original Boris Emorine copyright
CLAUDE.md Converted to a redirect file pointing to AGENTS.md for vendor-neutral AI instructions
AGENTS.md New file containing comprehensive project reference guide moved from CLAUDE.md with detailed build instructions and CI/CD documentation
CHANGELOG.md Added v2.2.0 release entry documenting the XCFramework build enhancement

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

@mrbiggred mrbiggred merged commit 97d9fc1 into release/2.2.0 Nov 13, 2025
2 checks passed
@mrbiggred mrbiggred deleted the feature/update-documentation-for-2.2.0-release branch November 13, 2025 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants