Document that cretonne-module is an optional part of Cretonne.

2018-07-03 08:45:52 -07:00
parent 5c7aeb46dd
commit b616644495
1 changed files with 4 additions and 0 deletions
--- 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.