From e71416a8bb5a0b5fd006fc02243e7e73e994bec3 Mon Sep 17 00:00:00 2001 From: Oliver Joseph Ash Date: Wed, 12 Mar 2014 17:42:13 +0000 Subject: [PATCH] Update example to demonstrate AMD [ci skip] --- README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 335f48d6..a3959e5f 100644 --- a/README.md +++ b/README.md @@ -44,17 +44,21 @@ bower install scribe
Enable/disable block element mode (enabled by default)
-## Example +## Usage Example + +Scribe is an AMD module: ``` js -var scribeElement = document.querySelector('.scribe'); -// Create an instance of Scribe -var scribe = new Scribe(scribeElement); - -// Use some plugins -scribe.use(scribePluginBlockquoteCommand()); -var toolbarElement = document.querySelector('.toolbar'); -scribe.use(scribePluginToolbar(toolbarElement)); +require(['scribe'], function () { + var scribeElement = document.querySelector('.scribe'); + // Create an instance of Scribe + var scribe = new Scribe(scribeElement); + + // Use some plugins + scribe.use(scribePluginBlockquoteCommand()); + var toolbarElement = document.querySelector('.toolbar'); + scribe.use(scribePluginToolbar(toolbarElement)); +}); ``` You can [see a live example here][example], or [view the code here](https://github.com/guardian/scribe/tree/gh-pages).