Skip to content

Commit 1447567

Browse files
committed
docs: Add core features section to README
1 parent b33b97d commit 1447567

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,27 @@ SynapS3 lets S3 clients use Filecoin storage.
1010
- Store object data through Filecoin providers.
1111
- Manage buckets, objects, settings, tasks, and health from one dashboard.
1212

13+
## Core Features
14+
15+
| Feature | Status | Note |
16+
| --- | --- | --- |
17+
| S3-compatible API || Standard S3 clients and tools |
18+
| Bucket and object operations || Create, upload, list, read, delete |
19+
| Multipart uploads || Large object upload flow |
20+
| Object versioning || Versions and delete markers |
21+
| Web dashboard || Buckets, objects, tasks, settings |
22+
| S3 user management || Access keys for S3 clients |
23+
| Filecoin storage backend || Storage through Synapse |
24+
| Automatic provider selection || Provider contexts from Synapse |
25+
| Configurable storage copies || Copy count is configurable |
26+
| Provider-backed reads || Reads can fall back to providers |
27+
| Wallet and payment tools || Wallet, testnet funding, USDFC |
28+
| Background task management || Monitor and retry tasks |
29+
| Managed provider policy | 📝 | Future provider controls |
30+
| Automatic repair | 📝 | Future replica repair loop |
31+
| One-click deployment | 📝 | Future deployment flow |
32+
| Production readiness | 📝 | Future hardening work |
33+
1334
## Quick Start
1435

1536
Prerequisites:

0 commit comments

Comments
 (0)