From 4accabc4e2d4e2dea8b485abbb2abf9cadd5359a Mon Sep 17 00:00:00 2001 From: Francesco Cozzuto Date: Mon, 17 Nov 2025 12:48:52 +0100 Subject: [PATCH] Add Features paragraph to README.md --- README.md | 21 +++++++++++++++++++-- TODO.txt | 1 + 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 8cc878c..0819694 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,24 @@ # ToastyFS -ToastyFS is a distributed file system for personal use. It's designed to be pragmatic, understandable, and robust. +ToastyFS is a distributed file system designed for self-hosting, so it aims to be pragmatic, understandable, and robust. -𝅘𝅥𝅮 𝅘𝅥𝅮 Now let's get toasty 𝅘𝅥𝅮 𝅘𝅥𝅮 +You can use ToastyFS to store your files reliably over multiple machines knowing they will be automatically replicated and healed in case of hardware failure. + +⚠️ Note that ToastyFS is still in early development ⚠️ + +🎵 Now let's get toasty 🎵 + +## Features + +- Cross-platform (runs on Windows and Linux) +- Automatic Replication & Self-Healing +- Automatic content deduplication: File contents are de-duplicated automatically with content-addressing. +- Configurable chunk sizes: Each file can have different chunk size optimized for its use case +- Zero dependencies: Pure C implementation with no external libraries + +But ToastyFS is still in early development, so here are the missing features: + +- No master replication +- No authentication or encryption ## Testing ToastyFS is tested by running an in-memory simulation of a cluster with many clients running hundreds of random operations in parallel. The test is run for long periods of times under valgrind or compiled with sanitizers. diff --git a/TODO.txt b/TODO.txt index f013e74..6cb3765 100644 --- a/TODO.txt +++ b/TODO.txt @@ -11,6 +11,7 @@ - Should list scenarios that need testing, like those where chunks would be dropped - Update DESIGN.txt and the code to remove the chunk list message. The information of chunks held by chunk servers is now transmitted to the metadata server during state updates +- clean up the replication factor business Roadmap: [ ] Complete all endpoints