Skip to content

Commit 4c9325a

Browse files
committed
Merge pull request usablica#5 from voltagex/1-english-fix
Some editing, part 1
2 parents 2d2bef0 + dd5f8fc commit 4c9325a

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
Intro.js
22
========
33

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.
55

66
##How to use
7-
Simple 3 steps.
7+
Intro.js can be added to your site in three simple steps:
88

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.
1010

1111
**2)** Add `data-intro` and `data-step` to your HTML elements.
1212
For example:
@@ -19,13 +19,14 @@ For example:
1919
introJs().start();
2020
````
2121

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'`.
2323

2424
##Roadmap
25-
- Browsers compatibility
25+
- More browser compatibility
2626

2727
##Contributors
2828
- [Afshin Mehrabani](http://afshinm.name/)
29+
- [@voltagex](http://github.com/voltagex)
2930

3031
##License
3132

example/index.html

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8">
5-
<title>Intro.js | A better way for new feature introduction and step-by-step users guide</title>
5+
<title>Intro.js | Better introductions for websites and features with a step-by-step guide for your projects.</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1.0">
7-
<meta name="description" content="Intro.js - A better way for new feature introduction and step-by-step users guide for your website and project.">
7+
<meta name="description" content="Intro.js -Better introductions for websites and features with a step-by-step guide for your projects.">
88
<meta name="author" content="Afshin Mehrabani (@afshinmeh) in usabli.ca group">
99

1010
<!-- Le styles -->
@@ -69,8 +69,8 @@ <h3 class="muted">Intro.js</h3>
6969
<hr>
7070

7171
<div class="jumbotron">
72-
<h1 data-step="1" data-intro="Hello all! :) This is the name of project, IntroJs.">Intro<span style="font-weight: normal;">.js</span></h1>
73-
<p class="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+
<h1 data-step="1" data-intro="Hello all! :) This project's called Intro.js.">Intro<span style="font-weight: normal;">.js</span></h1>
73+
<p class="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>
7474
<a class="btn btn-large btn-success" href="javascript:void(0);" onclick="javascript:introJs().start();">Show me how</a>
7575
</div>
7676

@@ -85,16 +85,15 @@ <h4>Fast & Small</h4>
8585
<p><strong>4 KB</strong> JavaScript and <strong>2 KB</strong> CSS. That's all.</p>
8686

8787
<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>
8989
</div>
9090

9191
<div class="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>
9794

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>
9897
<h4>Developed with <3</h4>
9998
<p>With <3 in <a href='http://usabli.ca/' target="_blank" title="usabli.ca group">usabli.ca</a>, Tehran.</p>
10099
</div>
@@ -109,4 +108,4 @@ <h4>Developed with <3</h4>
109108
</div>
110109
<script type="text/javascript" src="../minified/intro.min.js"></script>
111110
</body>
112-
</html>
111+
</html>

0 commit comments

Comments
 (0)