chore: Add readme

[BrieucCaillot]

No description provided.

[coderabbitai]

Warning

Rate limit exceeded

@BrieucCaillot has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 42 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 43daa49 and 16f4abf.

📒 Files selected for processing (1)

• README.md (1 hunks)

Walkthrough

A new README.md file is added documenting the Formance Wallets project. The file includes a banner image, project description, and a bulleted feature list covering multi-currency balances, temporary holds, reserved funds, and expirable fungibles.

Changes

Cohort / File(s)	Change Summary
Documentation README.md	New file added with project overview, banner image, descriptive content about Formance Wallets features, and capabilities list

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• No functional code changes; documentation-only addition
• Straightforward markdown content with no complex logic or dependencies to verify

Poem

🐰 A README hops into view,
With banners bright and features true,
Wallets dance with holds and funds,
Documentation's golden ones! ✨

Pre-merge checks and finishing touches

❌ Failed checks (2 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'chore: Add readme' is vague and generic. While it indicates a README file is being added, it lacks specificity about what the README documents (Formance Wallets) or any meaningful context about the changeset.	Consider a more descriptive title such as 'chore: Add Formance Wallets README with feature documentation' to provide better context about the changeset.
Description check	❓ Inconclusive	No pull request description was provided by the author, making it impossible to assess whether it relates to the changeset.	Add a pull request description that explains the purpose of the README, its content, and any relevant context about Formance Wallets documentation.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

README.md (1)

2-2: Improve image alt text for better accessibility and context.

The alt text "wallets" is generic. Consider a more descriptive phrase like "Formance Wallets service overview banner" to better describe the image content for screen readers.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between aaa528d and 43daa49.

📒 Files selected for processing (1)

• README.md (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Tests

🔇 Additional comments (1)

README.md (1)

1-3: URL is currently accessible; consider long-term availability strategy.

The banner image URL currently responds with HTTP 200. However, external CDN-hosted assets carry inherent risks—the URL could become unavailable if the CDN changes, the account is deleted, or the file is moved. Consider whether hosting the banner directly in the repository (e.g., in a docs/images/ directory) better aligns with your project's long-term maintenance strategy.

[coderabbitai]

⚠️ Potential issue | 🟠 Major

Resolve inconsistency between description and feature list regarding "Reserved funds" and "Expirable fungibles".

The description (line 7) states these are "upcoming support," but the features list (lines 11-14) presents them as current features. Please clarify:

• If they are currently available, remove "upcoming support" from the description.
• If they are planned but not yet implemented, remove them from the feature list or explicitly label them as "Coming soon."

Also applies to: 11-14

🤖 Prompt for AI Agents

In README.md around lines 7 and 11-14, the intro says "upcoming support" for
"reserved funds" and "expirable fungibles" while the feature list currently
presents them as available; choose one of the two: either remove "upcoming
support" from line 7 if those features are already implemented, or mark the two
items in the feature list (lines 11-14) as "Coming soon" or remove them if not
implemented. Update the text so the description and feature list consistently
reflect the current implementation status.