Skip to content

Commit 355ed28

Browse files
author
Arnaud Riess
committed
Enhance README formatting and clarify project status
1 parent 2f2a38a commit 355ed28

1 file changed

Lines changed: 4 additions & 8 deletions

File tree

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# herkos
22

3-
> This project is work in progress! Not all wasm features nor corner cases were tested!
3+
> ⚠️ *** This project is work in progress! Not all wasm features nor corner cases were tested!***
44
55
A compilation pipeline that transpiles WebAssembly modules into memory-safe Rust code with compile-time isolation guarantees, replacing runtime hardware-based memory protection (MMU/MPU) with type-system-enforced safety.
66

@@ -21,13 +21,9 @@ The project is a Rust workspace with three core crates:
2121
| `herkos` | CLI transpiler: parses `.wasm` binaries, emits Rust source code |
2222
| `herkos-runtime` | `#![no_std]` runtime library shipped with transpiled output (`IsolatedMemory`, capability types, Wasm operations) |
2323

24-
### Memory model
25-
26-
WebAssembly linear memory maps to `IsolatedMemory<const MAX_PAGES: usize>`, a flat `[[u8; PAGE_SIZE]; MAX_PAGES]` array with page-level const generics. All accesses go through bounds-checked `load<T>`/`store<T>`. Fully `no_std` compatible with zero heap allocation.
27-
28-
### Capability-based security
29-
30-
Wasm imports become Rust trait bounds on a generic host parameter. If a module doesn't import a capability, the trait bound isn't present; no code path to call it. Zero-cost via monomorphization.
24+
Features:
25+
- compile time isolation
26+
- compile time capability based security access via traits
3127

3228
## Build and test
3329

0 commit comments

Comments
 (0)