diff --git a/README.md b/README.md index 0338cd7..d1a0b49 100644 --- a/README.md +++ b/README.md @@ -1 +1,13 @@ # Trinity + +Trinity is a simulation testing library for the Elixir programming language. + +Processes are deterministically scheduled within a given simulation, and only one process is allowed to execute at a time. +Scheduling is done entirely in "user-space"; there are no modifications to the runtime (BEAM) itself. +Trinity reimplements a number of OTP primitives in order to guarantee deterministic execution, +and a simulated (in-memory) filesystem is also provided. + +## Status + +Trinity is experimental and under active development. +Documentation and an eventual release are planned.