Skip to content

Revise README with new version and AI contributions#32

Merged
RZEROSTERN merged 1 commit intomasterfrom
RZEROSTERN-patch-1
Mar 26, 2026
Merged

Revise README with new version and AI contributions#32
RZEROSTERN merged 1 commit intomasterfrom
RZEROSTERN-patch-1

Conversation

@RZEROSTERN
Copy link
Collaborator

This pull request updates the documentation to reference the latest beta version of the editorjs_flutter package in the installation instructions.

  • Documentation update:
    • Updated the pubspec.yaml example in README.md to use editorjs_flutter: ^0.5.0-beta.1 instead of ^0.5.0.

Updated README to reflect new package version and added AI-assisted contributions section.
Copilot AI review requested due to automatic review settings March 26, 2026 15:53
Copy link
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

This PR updates the package installation docs to reference a beta version of editorjs_flutter in the pubspec.yaml snippet.

Changes:

  • Updated README.md install example from editorjs_flutter: ^0.5.0 to editorjs_flutter: ^0.5.0-beta.1.

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

```yaml
dependencies:
editorjs_flutter: ^0.5.0
editorjs_flutter: ^0.5.0-beta.1
Copy link

Copilot AI Mar 26, 2026

Choose a reason for hiding this comment

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

The README now pins the install example to ^0.5.0-beta.1, but the repo’s own pubspec.yaml and CHANGELOG.md indicate the current package version is 0.5.0. This makes the install instructions potentially misleading. Either update the package metadata to match the beta naming, or adjust the README to reference ^0.5.0 (or add a note explaining why users should choose the beta). Also, if the goal is to keep users on the beta specifically, consider not using ^ since it can resolve to the stable 0.5.0 once published.

Copilot uses AI. Check for mistakes.
@RZEROSTERN RZEROSTERN merged commit 4c85a23 into master Mar 26, 2026
5 checks passed
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