Skip to content

Commit

Permalink
Changing to markup, for readability and clarity
Browse files Browse the repository at this point in the history
Adding markup, so the code is easy to read in the rendered version, as well as in `cat`.

Also reordered the sections, and renamed for clarity. Also no more yelling :(
  • Loading branch information
Kurtis Rainbolt-Greene committed Jun 23, 2011
1 parent 4fc0493 commit 9f96a40
Showing 1 changed file with 26 additions and 16 deletions.
42 changes: 26 additions & 16 deletions README.md
@@ -1,18 +1,15 @@
** LICENSE ** Guider.js
=========


Released under the Apache License 2.0. Guiders are a user experience design pattern for introducing users to a web application. Check out `README.html` for guiders in action!
http://www.apache.org/licenses/LICENSE-2.0.html




** SUMMARY ** Setup
-----


Guiders are a user experience design pattern for introducing users to a web application. Check out README.html for guiders in action! Here is sample code for initializing a couple of guiders. Guiders are hidden when created, unless `.show()` is method chained immediately after `.createGuider`.


** INITIALIZING GUIDERS **

Here is sample code for initializing a couple of guiders. Guiders are hidden when created, unless .show() is method chained immediately after .createGuider.


~~~ javascript
guider.createGuider({ guider.createGuider({
buttons: [{name: "Next"}], buttons: [{name: "Next"}],
description: "Guiders are a user interface design pattern for introducing features of software. This dialog box, for example, is the first in a series of guiders that together make up a guide.", description: "Guiders are a user interface design pattern for introducing features of software. This dialog box, for example, is the first in a series of guiders that together make up a guide.",
Expand All @@ -22,7 +19,7 @@ guider.createGuider({
title: "Welcome to Guiders.js!" title: "Welcome to Guiders.js!"
}).show(); }).show();
/* .show() means that this guider will get shown immediately after creation. */ /* .show() means that this guider will get shown immediately after creation. */

guider.createGuider({ guider.createGuider({
attachTo: "#clock", attachTo: "#clock",
buttons: [{name: "Close, then click on the clock.", onclick: guider.hideAll}], buttons: [{name: "Close, then click on the clock.", onclick: guider.hideAll}],
Expand All @@ -33,9 +30,11 @@ guider.createGuider({
title: "You can also advance guiders from custom event handlers.", title: "You can also advance guiders from custom event handlers.",
width: 450 width: 450
}); });
~~~~


The parameters for creating guiders are: The parameters for creating guiders are:


~~~
attachTo: (optional) selector of the html element you want to attach the guider to attachTo: (optional) selector of the html element you want to attach the guider to
buttons: array of button objects buttons: array of button objects
{ {
Expand All @@ -50,21 +49,32 @@ overlay: (optional) if true, an overlay will pop up between the guider and the r
position: (optional / required if using attachTo) clock position at which the guider should be attached to the html element position: (optional / required if using attachTo) clock position at which the guider should be attached to the html element
title: title of the guider title: title of the guider
width: (optional) custom width of the guider (it defaults to 400px) width: (optional) custom width of the guider (it defaults to 400px)
~~~




** INTEGRATION WITH YOUR WEB APPLICATION ** Integration
-----------


Besides creating guiders, here is sample code you can use in your application to work with guiders: Besides creating guiders, here is sample code you can use in your application to work with guiders:


~~~ javascript
guider.hideAll(); // hides all guiders guider.hideAll(); // hides all guiders
guider.next(); // hides the last shown guider, if shown, and advances to the next guider guider.next(); // hides the last shown guider, if shown, and advances to the next guider
guider.show(id); // shows the guider, given the id used at creation guider.show(id); // shows the guider, given the id used at creation
~~~

You'll likely want to change the default values, such as the width (set to 400px). These can be found at the top of `guider.js` in the `_defaultSettings` object. You'll also want to modify the css file to match your application's branding.


In Closing
----------


You'll likely want to change the default values, such as the width (set to 400px). These can be found at the top of guider.js in the _defaultSettings object. You'll also want to modify the css file to match your application's branding. Guiders are a great way to improve the user experience of your web application. If you're interested in optimizing user experience through A/B testing, check out [Optimizely](optimizely.com). We're the people who built Guiders in the first place.


If you have questions about Guiders or Optimizely, email us at `jeff+pickhardt@optimizely.com` or `hello@optimizely.com`.


** IN CLOSING **


Guiders are a great way to improve the user experience of your web application. If you're interested in optimizing user experience through A/B testing, check out Optimizely (optimizely.com). We're the people who built Guiders in the first place. License
-------


If you have questions about Guiders or Optimizely, email us at jeff+pickhardt@optimizely.com or hello@optimizely.com. Released under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).

0 comments on commit 9f96a40

Please sign in to comment.