diff --git a/README.md b/README.md index 309b552..52f83e0 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@

Rusty MuJoCo Binding

Rust bindings for the MuJoCo physics simulator

-

MuJoCo Version: 3.3.2

+

MuJoCo Version: 3.3.2


-- Provides direct Rusty binding to all MuJoCo APIs. -- Provides getter methods for all struct fields and setter methods for all fields - intended to be user-modifiable, instead of direct field access. -- Offers as much type-safety and efficiency as possible on the lean binding interface. - (e.g. `mj_name2id` and many other functions or methods handle `ObjectId` - instead of primitive integer, requiring only once `mj_name2id` call per object and - assuring the object id to be valid in entire a simulation) -- Automatically handles resource management of some types with heap allocation. - (e.g. calling `mj_deleteModel` for `mjModel` in its `Drop` impl) +- Offers safe, direct Rust wrappers for the entire MuJoCo API. +- Provides getters for all struct fields and setters for user-modifiable fields, + instead of allowing direct field access. +- Implements automatic resource management via Rust's RAII pattern. + For example, `mjModel` automatically calls `mj_deleteModel` in its `Drop` implementation, preventing memory leaks. +- Emphasizes type-safety and efficiency within a lean binding interface. + For instance, the `ObjectId` type system replaces raw integer IDs to: + - Ensure compile-time safety for all object-related operations. + - Improve performance by eliminating the need for repeated `mj_name2id` lookups.