Fix version number in README

[lawrence-forooghian]

Summary by CodeRabbit

• Documentation
  • Updated release process instructions to clarify manual version updates required before release.
  • Updated installation instructions to reference the latest SDK version.
  • Added a note about future automation of version updates.

[coderabbitai]

Walkthrough

The changes update documentation related to the release process and installation instructions. The release process in CONTRIBUTING.md now specifies that both the version constant in the code and the version string in the README must be updated manually before a release. It also references a future plan to automate this with a script. Separately, the README's Swift Package Manager installation instructions have been updated to use version "0.3.0" instead of "0.1.0".

Changes

Files	Change Summary
CONTRIBUTING.md	Clarified release process to require manual updates of both the code version and README version string; referenced a future automation issue.
README.md	Updated Swift Package Manager installation instructions to reference version "0.3.0" instead of "0.1.0".

Possibly related PRs

• [ECO-5102] Updated README #166: Updates to the README.md file regarding versioning and installation instructions, directly improving documentation for the SDK.
• Add an initial release process and CHANGELOG #181: Initial setup of the release process and changelog, which is further refined in this PR.
• Release version 0.3.0 #269: Performs the actual version bump in Version.swift and documents the 0.3.0 release, closely related to the current documentation updates.

Suggested reviewers

• umair-ably

Poem

A bunny with a pen and pad,
Updates the docs—oh, how glad!
From "0.1.0" to "0.3.0" we leap,
Manual steps for now, automation to keep.
With every release, we hop ahead—
Clearer instructions, enough said!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 73d423f and f2c7799.

📒 Files selected for processing (2)

• CONTRIBUTING.md (1 hunks)
• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Xcode, iOS (Xcode 16.1)

🔇 Additional comments (2)

CONTRIBUTING.md (1)

175-177: Release process documentation improved—LGTM

The updated instructions clarify the need to update both the code and documentation version numbers before a release, reducing the risk of inconsistencies. The reference to future automation is also helpful. No issues found.

README.md (1)

32-32: SPM installation version updated—LGTM

The version bump in the installation instructions is correct and aligns with the clarified release process. No issues found.

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.