Skip to content

Commit 4b88dd6

Browse files
authored
Update README.md
1 parent 2e9f891 commit 4b88dd6

File tree

1 file changed

+0
-27
lines changed

1 file changed

+0
-27
lines changed

README.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,3 @@
1-
### Atomic Transactions (Experimental)
2-
3-
[Detailed design and usage docs](internal/atomic/README.md)
4-
5-
Add and delete operations are executed via a lightweight transactional journal to prevent partial state (half-written manifests or orphaned chunks).
6-
7-
Workflow:
8-
9-
1. Start a transaction: new/replacement files written under `.txn/<id>/new/`.
10-
2. Deletions move originals to `.txn/<id>/trash/`.
11-
3. Commit promotes all staged files (atomic renames) and removes trash.
12-
4. Rollback removes staged files and restores trash originals.
13-
14-
Manual recovery:
15-
16-
```
17-
sietch recover --retention 24h
18-
```
19-
20-
Scans `.txn/` for incomplete transactions and resumes or rolls them back. Completed journals older than the retention window are purged.
21-
22-
Limitations / Next Steps:
23-
24-
- Current scope covers `add` and `delete` commands.
25-
- Further commands (sync, sneakernet transfer) can adopt the same API later.
26-
- Fault injection hooks for deterministic testing are planned.
27-
281
# Sietch Vault
292

303
[![CI](https://github.com/substantialcattle5/sietch/actions/workflows/ci.yml/badge.svg)](https://github.com/substantialcattle5/sietch/actions/workflows/ci.yml)

0 commit comments

Comments
 (0)