From 6c81a8d46dda1b1b8e7b548769a52d23decfc37e Mon Sep 17 00:00:00 2001
From: David Baker <dave@matrix.org>
Date: Tue, 7 Jul 2015 18:27:34 +0100
Subject: [PATCH] Add blurb on how to build a customised app.
---
README.md | 22 ++++++++++++++++++++--
1 file changed, 20 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index e49305c2..01ecb950 100644
--- a/README.md
+++ b/README.md
@@ -127,5 +127,23 @@ In practice this means:
of the modularity requirements it brings to the table.
With all this in mind, here's how you go about skinning the react SDK UI
-components to embed a Matrix client into your app: TODO. For now, check out
-the examples and work it out for yourself...
+components to embed a Matrix client into your app:
+
+ * Create a new NPM project. Be sure to directly depend on react, (otherwise
+ you can end up with two copies of react).
+ * Create an index.js file that sets up react. Add require statements for
+ React, the ComponentBroker and matrix-react-sdk and a call to Render
+ the root React element as in the examples.
+ * Create React classes for any custom components you wish to add. These
+ can be based off the files in `views` in the `matrix-react-sdk` package,
+ modifying the require() statement appropriately.
+ You only need to copy files you want to customise.
+ * Add a ComponentBroker.set() call for each of your custom components. These
+ must come *before* `require("matrix-react-sdk")`.
+ * Add a way to build your project: we suggest copying the browserify calls
+ from the example projects, but you could use grunt or gulp.
+ * Create an index.html file pulling in your compiled index.js file, the
+ CSS bundle from matrix-react-sdk.
+
+For more specific detail on any of these steps, look at the `custom` example in
+matrix-react-sdk/examples.