diff --git a/lib/module/README.md b/lib/module/README.md index 370bde4333..4ff52c3d2d 100644 --- a/lib/module/README.md +++ b/lib/module/README.md @@ -1,3 +1,7 @@ This crate provides the `Module` trait, which provides an interface for multiple functions and data to be emitted with [Cretonne](https://crates.io/crates/cretonne) and then linked together. + +This crate is structured as an optional layer on top of cretonne-codegen. +It provides additional functionality, such as linking, however users that +require greater flexibility don't need to use it.