diff --git a/giterated-stack/README.md b/giterated-stack/README.md index 8c26c29..3f3fed8 100644 --- a/giterated-stack/README.md +++ b/giterated-stack/README.md @@ -13,9 +13,8 @@ A `GiteratedStack` is created by merging any number of `SubstackBuilder`s into t `GiteratedStack` uses traits to embed reflection into the binary. `GiteratedStack` generates this reflection metadata at runtime from traits which are inherent on the types it is reflecting. This means that if, for example, `T: ValueMeta`: `T` also has an implementation of `T: IntoValueMeta`. -Giterated's Unifed Stack uses the `IntoValueMeta` implementation (generated by the compiler) to populate function pointers for reflection. We avoid an extra allocation over boxed `Fn*` traits. - +* Giterated's Unifed Stack uses the `IntoValueMeta` implementation (generated by the compiler) to populate function pointers for reflection. We avoid an extra allocation over boxed `Fn*` traits. * Reflection is used in Giterated to allow for deserializing objects and operations into their concrete type as soon as possible. @@ -38,4 +37,5 @@ The design of the Giterated Unified Stack is intended to create a data structure ## Implementation -It is a goal for `giterated-stack` to be `#![no_std]` with `alloc`. This is to better facilitate integration through WASM support, support for more targets, and libraries that are more slim. \ No newline at end of file +- It is crucial that the internals of Giterated's Unified Stack (reflection, etc) remain well-encapsulated and consumers do not have to concern themselves with the internals. +- It is a goal for `giterated-stack` to be `#![no_std]` with `alloc`. This is to better facilitate integration through WASM support, support for more targets, and libraries that are more slim. \ No newline at end of file