1
- Intro.js
2
- ========
1
+ # Intro.js
3
2
4
- Better introductions for websites and features with a step-by-step guide for your projects.
3
+ > Better introductions for websites and features with a step-by-step guide for your projects.
5
4
6
- ##How to use
5
+
6
+ ## How to use
7
7
Intro.js can be added to your site in three simple steps:
8
8
9
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
13
For example:
14
+
13
15
``` html
14
16
<a href =' http://google.com/' data-intro =' Hello step one!' data-step =' 1' ></a >
15
17
````
@@ -19,54 +21,57 @@ For example:
19
21
introJs().start();
20
22
````
21
23
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'`.
24
+ Optionally, pass one parameter to `introJs` function to limit the presentation section.
25
+
26
+ **For example** `introJs(".introduction-farm").start();` runs the introduction only for elements with `class='introduction-farm'`.
23
27
24
28
<p align =" center" ><img src =" http://usablica.github.com/intro.js/img/introjs-demo.jpg" ></p >
25
29
26
- ##Using with:
27
30
28
- ###Rails
31
+ ## Using with:
29
32
33
+ ### Rails
30
34
If you are using the rails asset pipeline you can use the [introjs-rails](https://github.com/heelhook/intro.js-rails) gem.
31
35
32
- ###Yii framework
36
+ ### Yii framework
33
37
You can simply use this project for Yii framework: https://github.com/moein7tl/Yii-IntroJS
34
38
35
- ##Roadmap
39
+ ## Roadmap
36
40
- More browser compatibility
37
41
- Adding ability to define tooltip position in each step, `top`, `left,` `right` and `bottom`
38
42
- Fix overlay layer bug while using it in wide monitors and `document` object
39
43
- Change `Next` and `Skip` buttons
40
44
- Add complete introduction callback
41
45
42
- ##History
43
46
44
- ###v0.1.0 - March 16, 2013
45
- First version
47
+ ## Release History
48
+ * 2013-03-16 v0.1.0 First commit.
46
49
50
+ ## Author
51
+ **Afshin Mehrabani**
47
52
48
- ##Main Contributors
49
- - [Afshin Mehrabani ](http://afshinm.name/)
53
+ + [https://github.com/afshinm](https://github.com/afshinm)
54
+ - [http://afshinm.name/ ](http://afshinm.name/)
50
55
51
- other contributors: https://github.com/usablica/intro.js/contributors
56
+ [Other contributors]( https://github.com/usablica/intro.js/graphs/ contributors)
52
57
53
- ##Support/Discussion
54
58
59
+ ## Support/Discussion
55
60
- [Google Group](https://groups.google.com/d/forum/introjs)
56
61
57
- ##License
58
-
59
- Copyright (C) 2012 Afshin Mehrabani (
[email protected] )
60
-
61
- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
62
- documentation files (the "Software"), to deal in the Software without restriction, including without limitation
63
- the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
64
- and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
65
- The above copyright notice and this permission notice shall be included in all copies or substantial portions
66
- of the Software.
67
-
68
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
69
- TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
70
- THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
71
- CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
72
- IN THE SOFTWARE.
62
+
63
+ ## License
64
+ > Copyright (C) 2012 Afshin Mehrabani (
[email protected] )
65
+
66
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
67
+ documentation files (the "Software"), to deal in the Software without restriction, including without limitation
68
+ the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
69
+ and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
70
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions
71
+ of the Software.
72
+
73
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
74
+ TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
75
+ THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
76
+ CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
77
+ IN THE SOFTWARE.
0 commit comments