Skip to content

Commit 6eadc4a

Browse files
committed
README formatting improvements. See gist preview here before you accept pull: https://gist.github.com/jonschlinkert/68c42edb4ec2baa19bcd
1 parent 2bcce50 commit 6eadc4a

File tree

1 file changed

+37
-32
lines changed

1 file changed

+37
-32
lines changed

README.md

Lines changed: 37 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
1-
Intro.js
2-
========
1+
# Intro.js
32

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.
54
6-
##How to use
5+
6+
## How to use
77
Intro.js can be added to your site in three simple steps:
88

99
**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.
12+
1213
For example:
14+
1315
```html
1416
<a href='http://google.com/' data-intro='Hello step one!' data-step='1'></a>
1517
````
@@ -19,54 +21,57 @@ For example:
1921
introJs().start();
2022
````
2123

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

2428
<p align="center"><img src="http://usablica.github.com/intro.js/img/introjs-demo.jpg"></p>
2529

26-
##Using with:
2730

28-
###Rails
31+
## Using with:
2932

33+
### Rails
3034
If you are using the rails asset pipeline you can use the [introjs-rails](https://github.com/heelhook/intro.js-rails) gem.
3135

32-
###Yii framework
36+
### Yii framework
3337
You can simply use this project for Yii framework: https://github.com/moein7tl/Yii-IntroJS
3438

35-
##Roadmap
39+
## Roadmap
3640
- More browser compatibility
3741
- Adding ability to define tooltip position in each step, `top`, `left,` `right` and `bottom`
3842
- Fix overlay layer bug while using it in wide monitors and `document` object
3943
- Change `Next` and `Skip` buttons
4044
- Add complete introduction callback
4145

42-
##History
4346

44-
###v0.1.0 - March 16, 2013
45-
First version
47+
## Release History
48+
* 2013-03-16 v0.1.0 First commit.
4649

50+
## Author
51+
**Afshin Mehrabani**
4752

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/)
5055

51-
other contributors: https://github.com/usablica/intro.js/contributors
56+
[Other contributors](https://github.com/usablica/intro.js/graphs/contributors)
5257

53-
##Support/Discussion
5458

59+
## Support/Discussion
5560
- [Google Group](https://groups.google.com/d/forum/introjs)
5661

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

Comments
 (0)