Add Features paragraph to README.md

This commit is contained in:
2025-11-17 12:48:52 +01:00
parent 09f1ed4b3e
commit 4accabc4e2
2 changed files with 20 additions and 2 deletions
+19 -2
View File
@@ -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.