chore: update README and licenses

RatCornu · Jan 8, 2024 · 85ef242 · 85ef242
1 parent e35ca78
commit 85ef242
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 0 deletions.
diff --git a/LICENSE-APACHE → LICENSE-APACHE.md b/LICENSE-APACHE → LICENSE-APACHE.md
diff --git a/LICENSE-MIT → LICENSE-MIT.md b/LICENSE-MIT → LICENSE-MIT.md
diff --git a/README.md b/README.md
@@ -14,3 +14,42 @@
 # Extended fs
 
 An OS and architecture independent implementation of some Unix filesystems in Rust.
+
+## Features
+
+* `no_std` support (enabled by default)
+
+* General interface for UNIX filesystems
+
+* `read`/`write` regular files
+
+* Read directories content
+
+## Supported filesystems
+
+* [`ext2`](https://en.wikipedia.org/wiki/Ext2): ✅
+
+* [`ext3`](https://en.wikipedia.org/wiki/Ext2): ❌
+
+* [`ext4`](https://en.wikipedia.org/wiki/Ext2): ❌
+
+* [`fatfs`](https://en.wikipedia.org/wiki/FatFs): ❌
+
+## Usage
+
+Add this to your `Cargo.toml`:
+
+```
+[dependencies]
+efs = "0.2"
+```
+
+<!-- Add examples on 0.3 release --> 
+
+## Features
+
+* `ext2`: enable the `ext2` filesystem support
+
+* `std`: enable the features depending on the standard library
+
+By default, only the `ext2` feature is set.