From b6166444951a3451f92ffc50925eca03f8eb9300 Mon Sep 17 00:00:00 2001
From: Dan Gohman <sunfish@mozilla.com>
Date: Tue, 3 Jul 2018 08:45:52 -0700
Subject: [PATCH] Document that cretonne-module is an optional part of
 Cretonne.

---
 lib/module/README.md | 4 ++++
 1 file changed, 4 insertions(+)

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.