From 668e780806326fc307e57bde81f562f8a1340177 Mon Sep 17 00:00:00 2001
From: Ryan Levick <ryan.levick@fermyon.com>
Date: Fri, 5 Apr 2024 15:09:41 +0200
Subject: [PATCH] Add a very simple example of the wac language to the README

Signed-off-by: Ryan Levick <ryan.levick@fermyon.com>
---
 README.md | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 53 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 917b292..fc9ceba 100644
--- a/README.md
+++ b/README.md
@@ -23,10 +23,60 @@ together.
 The tool uses the WAC (pronounced "whack") language to define how components
 composed together.
 
-## Language
+## The `wac` Language
 
-See the [language documentation](LANGUAGE.md) for more information on the
-syntax of WAC.
+The `wac` language is a declarative superset of [`wit`](https://component-model.bytecodealliance.org/design/wit.html) 
+for describing how components are composed together.
+
+As an example, imagine two components name.wasm and greeter.wasm.
+
+The wit for name.wasm is:
+
+```wit
+package example:name;
+
+world name {
+  /// Exporting a 'name' function that returns a name to greet.
+  export name: func() -> string;
+}
+```
+
+And the wit for greeter.wasm is:
+
+```wit
+package example:greeter;
+
+world greeter {
+  /// Importing a 'name' function that returns the name to greet.
+  import name: func() -> string;
+  /// Exporting a 'greet' function that returns a greeting using the name.
+  export greet: func() -> string;
+}
+```
+
+The following is an example of a wac file that composes these two components together 
+by plugging name.wasm's "name" export into greeter.wasm's "name" import.
+
+```wac
+package example:composition;
+
+// Instantiate the `name` component
+let n = new example:name {};
+
+// Instantiate the `greeter` component by plugging its `name`
+// import with the `name` export of the `name` component.
+let greeter = new example:greeter {
+  name: n.name,
+};
+
+// Export the greet function from the greeter component
+export greeter.greet;
+```
+
+The result of encoding this composition is a single component that
+does not import anything and only exports the "greet" function.
+
+For a full description of the `wac` language see [the language guide](LANGUAGE.md).
 
 ## Installation