Skip to content

chore: Add readme #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
flemzord merged 1 commit into from
Nov 7, 2025
Merged

chore: Add readme #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<p align="center">
<img src="https://formance01.b-cdn.net/Github-Attachements/banners/wallets-readme-banner.webp" alt="wallets" width="100%" />
</p>

# Formance Wallets

Wallets is a fully managed, white-label wallet service to materialize and spend users funds. It comes with built-in support for multi-currency balances and temporary holds capabilities (and upcoming support for reserved funds and expirable fungibles). It is built on top of the Formance Ledger service and is designed to provide an easy way to add wallets capabilities to your application without having to worry about the underlying transactions structure, providing an opinionated model implementation.
Copy link

@coderabbitai coderabbitai bot Nov 7, 2025

Choose a reason for hiding this comment

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

⚠️ 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.


## Features

- Multi-currency balances
- Temporary holds
- Reserved funds
- Expirable fungibles

- [Documentation](https://docs.formance.com/modules/wallets)
- [API Reference](https://docs.formance.com/api-reference/introduction)

## Documentation

- [Documentation](https://docs.formance.com/modules/wallets)
- [API Reference](https://docs.formance.com/api-reference/wallets)