From dab80b58ae8745000f6057c57dcaee78985616c7 Mon Sep 17 00:00:00 2001
From: Daniel Imms <tyriar@tyriar.com>
Date: Tue, 7 Jun 2016 22:31:39 -0700
Subject: [PATCH] Add section on addons to README

---
 README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README.md b/README.md
index 14044416..80e55ad7 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,23 @@ Xterm.js supplies a modular, event-based interface that lets developers build ad
 
 ![xterm.js screenshot](xtermjs.png)
 
+## Addons
+
+Addons are JavaScript modules that attach functions to the `Terminal` prototype to extend its functionality. There are a handful available in the main repository in the `addons` directory, you can even write your own (though they may break when the internals of xterm.js change across versions).
+
+To use an addon, just include the JavaScript file after xterm.js and before the `Terminal` object has been instantiated. The function should then be exposed on the `Terminal` object:
+
+```html
+<script src="node_modules/src/xterm.js"></script>
+<script src="node_modules/addons/linkify/linkify.js"></script>
+```
+
+```js
+var xterm = new Terminal();
+// init code...
+xterm.linkify();
+```
+
 ### Contribution and License Agreement
 
 If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work.