You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-5Lines changed: 6 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
Intro.js
2
2
========
3
3
4
-
A better way for new feature introduction and step-by-step users guide for your website and project.
4
+
Better introductions for websites and features with a step-by-step guide for your projects.
5
5
6
6
##How to use
7
-
Simple 3 steps.
7
+
Intro.js can be added to your site in three simple steps:
8
8
9
-
**1)** Include `intro.js` and `introjs.css` (or minified version for production) in your page.
9
+
**1)** Include `intro.js` and `introjs.css` (or the minified version for production) in your page.
10
10
11
11
**2)** Add `data-intro` and `data-step` to your HTML elements.
12
12
For example:
@@ -19,13 +19,14 @@ For example:
19
19
introJs().start();
20
20
````
21
21
22
-
Also you can pass one parameter to `introJs` function to limit the presentation section, for example `introJs(".introduction-farm").start();` runs the introduction only for elements with `class='introduction-farm'`.
22
+
Optionally, pass one parameter to `introJs` function to limit the presentation section, for example `introJs(".introduction-farm").start();` runs the introduction only for elements with `class='introduction-farm'`.
<metaname="description" content="Intro.js - A better way for new feature introduction and step-by-step users guide for your website and project.">
7
+
<metaname="description" content="Intro.js -Better introductions for websites and features with a step-by-step guide for your projects.">
8
8
<metaname="author" content="Afshin Mehrabani (@afshinmeh) in usabli.ca group">
9
9
10
10
<!-- Le styles -->
@@ -69,8 +69,8 @@ <h3 class="muted">Intro.js</h3>
69
69
<hr>
70
70
71
71
<divclass="jumbotron">
72
-
<h1data-step="1" data-intro="Hello all! :) This is the name of project, IntroJs.">Intro<spanstyle="font-weight: normal;">.js</span></h1>
73
-
<pclass="lead" data-step="4" data-intro="Let's try it. It's free and open-source.">A better way for new feature introduction and step-by-step users guide for your website and project.</p>
72
+
<h1data-step="1" data-intro="Hello all! :) This project's called Intro.js.">Intro<spanstyle="font-weight: normal;">.js</span></h1>
73
+
<pclass="lead" data-step="4" data-intro="Let's try it. It's free and open-source.">Better introductions for websites and features with a step-by-step guide for your projects.</p>
74
74
<aclass="btn btn-large btn-success" href="javascript:void(0);" onclick="javascript:introJs().start();">Show me how</a>
75
75
</div>
76
76
@@ -85,16 +85,15 @@ <h4>Fast & Small</h4>
85
85
<p><strong>4 KB</strong> JavaScript and <strong>2 KB</strong> CSS. That's all.</p>
86
86
87
87
<h4>Free & Open-Source</h4>
88
-
<p>Free and open-source to commercial use. Published under MIT license.</p>
88
+
<p>Free and open-source (including commercial use). Published under MIT license.</p>
89
89
</div>
90
90
91
91
<divclass="span6" data-step="3" data-intro="More features, more fun.">
92
-
<h4>Keyboard + Mouse navigating</h4>
93
-
<p>Ability to navigating with Mouse and Keyboard arrows, <code>←</code>, <code>→</code> and <code>ESC</code> to exit.</p>
94
-
95
-
<h4>Browsers Compatibllity</h4>
96
-
<p>Currently for Modern Browsers only, but I'll try to make it compatible for old browsers also in next versions.</p>
92
+
<h4>Keyboard + Mouse navigation</h4>
93
+
<p>Ability to navigate with the mouse, or the keyboard - <code>←</code>, <code>→</code> and <code>ESC</code> to exit.</p>
97
94
95
+
<h4>Browser Compatibllity</h4>
96
+
<p>Better compatibility is on the roadmap, but currently it should work in recent versions of Firefox and Chrome (probably IE10, too!)</p>
0 commit comments