1.x fixes - automated updates

[lalalune]

Automated updates for 1.x compatibility:

• Generate comprehensive README.md
• Generate package description
• Update dependencies and configuration

This PR was automatically generated by the bulk plugin updater.

Summary by CodeRabbit

• Documentation
  • Rewrote and restructured the README for improved clarity, updated installation and usage instructions, and expanded contribution guidelines.
• Chores
  • Added a descriptive summary to the package metadata.

[coderabbitai]

Walkthrough

The updates include a comprehensive rewrite and restructuring of the README documentation, featuring a new package name, improved installation and usage instructions, and clearer contribution guidelines. Additionally, a descriptive "description" field has been added to the package.json file. No source code or API changes were made.

Changes

File(s)	Change Summary
README.md	Completely rewritten and restructured for clarity, new package name, updated usage and contribution instructions, removed old sections, added practical examples.
package.json	Added a top-level "description" field describing the package’s purpose; formatting adjusted.

Poem

In README fields, new words now grow,
With guidance clear on how to Flow.
A package described with purpose bright,
For ElizaOS agents, day and night.
With every hop and every line,
The docs and metadata now align!
🐇✨

✨ Finishing Touches

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment

---

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

README.md (3)

9-15: Align table of contents with sections
The TOC entry "Actions and Providers" is combined but the content splits them; consider renaming or splitting the TOC items for consistency.

---

30-39: Rename configuration section
This section lists dependencies rather than runtime config. Consider renaming it to "Dependencies" or "Prerequisites".

---

79-91: Remove empty providers section
Since no providers are defined, omitting this subsection will streamline the README.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between cb637c3 and ec6343b.

📒 Files selected for processing (2)

• README.md (1 hunks)
• package.json (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[uncategorized] ~85-~85: Loose punctuation mark.
Context: ...ey actions include: - sendTransaction: Sends a transaction to the Flow blockch...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~86-~86: Loose punctuation mark.
Context: ...n to the Flow blockchain. - getAccount: Retrieves account information from the ...

(UNLIKELY_OPENING_PUNCTUATION)

🔇 Additional comments (14)

package.json (8)

2-3: Approve updated package name and version
The new name and bumped version align with the 1.x release.

---

8-15: Validate exports mapping
The nested "import", "types", and "default" export conditions should be tested against your target Node.js, bundler, and TypeScript setups to ensure they resolve correctly.

---

18-32: Dependencies update looks good
The runtime dependencies reflect the Flow integration requirements.

---

33-39: DevDependencies update looks good
Build and test tools (biome, tsup, vitest) are appropriately versioned.

---

40-49: Scripts section is solid
Build, lint, format, and test commands cover the standard development workflow.

---

50-52: Peer dependency declared correctly
Locking whatwg-url as a peer dependency avoids bundling conflicts.

---

53-74: Agent configuration block is clear
The agentConfig schema documents all required plugin parameters for ElizaOS.

---

76-76: Add description for NPM metadata
The new "description" field enhances discoverability on npm and aligns with the README.

README.md (6)

1-6: Update plugin name and overview
The title and overview accurately reflect @elizaos-plugins/plugin-flow and its purpose.

---

18-28: Installation instructions are clear
npm and yarn commands correctly install the plugin under the new package name.

---

43-77: Verify usage example
Please confirm that FlowPlugin and agent.plugins.flow.sendTransaction match the actual exported API in code.

---

93-100: Troubleshooting steps are comprehensive
The four-step guide covers dependency, network, error, and documentation checks.

---

102-109: Contributing guidelines are solid
Fork, branch, commit, and PR steps are clearly articulated.

---

110-111: Issue invitation is appropriate
Encouraging contributors to open an issue fosters community engagement.