Skip to content

Commit d6bb38e

Browse files
authored
Merge pull request #756 from loryjs/cleanup-readme
Cleanup some little readme things
2 parents 8b9d808 + b83e67e commit d6bb38e

File tree

2 files changed

+30
-29
lines changed

2 files changed

+30
-29
lines changed

.gitattributes

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
index.html linguist-documentation
2+
src/index.html linguist-documentation
3+
static/jquery-example.html linguist-documentation

README.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
21
<p align="center">
32
<img src="./static/lory.png" width="200px" />
43
</p>
54

6-
Please visit: [http://meandmax.github.io/lory/](http://meandmax.github.io/lory/ "lory")
5+
Please visit: [http://meandmax.github.io/lory/](http://meandmax.github.io/lory/ 'lory')
76

87
> Touch enabled minimalistic slider written in vanilla JavaScript.
98
@@ -20,9 +19,6 @@ Please visit: [http://meandmax.github.io/lory/](http://meandmax.github.io/lory/
2019
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
2120
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
2221

23-
24-
[![Build Status](https://saucelabs.com/buildstatus/meandmax?saucy)](https://saucelabs.com/beta/builds/ed0e8606c4d84e31b3528326192e0a46)
25-
2622
## Download
2723

2824
lory is released under the MIT license & supports modern environments.
@@ -39,29 +35,29 @@ yarn add lory.js
3935
## Consume it as an ES2015 module:
4036

4137
```js
42-
import {lory} from 'lory.js';
38+
import { lory } from 'lory.js';
4339

44-
document.addEventListener('DOMContentLoaded', () => {
45-
const slider = document.querySelector('.js_slider');
40+
document.addEventListener('DOMContentLoaded', () => {
41+
const slider = document.querySelector('.js_slider');
4642

47-
lory(slider, {
48-
// options going here
49-
});
43+
lory(slider, {
44+
// options going here
5045
});
46+
});
5147
```
5248

5349
## Consume it as an commonJS module:
5450

5551
```js
56-
var lory = require('lory.js').lory;
52+
var lory = require('lory.js').lory;
5753

58-
document.addEventListener('DOMContentLoaded', function() {
59-
var slider = document.querySelector('.js_slider');
54+
document.addEventListener('DOMContentLoaded', function() {
55+
var slider = document.querySelector('.js_slider');
6056

61-
lory(slider, {
62-
// options going here
63-
});
57+
lory(slider, {
58+
// options going here
6459
});
60+
});
6561
```
6662

6763
## Install with bower
@@ -130,7 +126,8 @@ yarn run karma-local
130126
* (optional) define here the style definitions which should be applied on the slider container
131127
* e.g. width including further controls like arrows etc.
132128
*/
133-
.slider {}
129+
.slider {
130+
}
134131

135132
.frame {
136133
/**
@@ -375,23 +372,24 @@ li {
375372
Please, do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](http://stackoverflow.com/questions/tagged/lory) where maintainers are looking at questions tagged with `loryJS`.
376373

377374
StackOverflow is a much better place to ask questions since:
378-
* There are hundreds of people willing to help on StackOverflow
379-
* Questions and answers stay available for public viewing so your question / answer might help someone else
380-
* The StackOverflow voting system assures that the best answers are prominently visible.
375+
376+
- There are hundreds of people willing to help on StackOverflow
377+
- Questions and answers stay available for public viewing so your question / answer might help someone else
378+
- The StackOverflow voting system assures that the best answers are prominently visible.
381379

382380
To enforce this rule will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.
383381

384382
## Browser Support
385383

386-
* Chrome
387-
* Safari
388-
* FireFox
389-
* Opera
390-
* Internet Explorer 10+
384+
- Chrome
385+
- Safari
386+
- FireFox
387+
- Opera
388+
- Internet Explorer 10+
391389

392-
* Internet Explorer 9 (graceful, without transitions + classlistp)
393-
- graceful, without transitions
394-
- you need to polyfill classlist (https://github.com/eligrey/classList.js/)
390+
- Internet Explorer 9 (graceful, without transitions + classlistp)
391+
- graceful, without transitions
392+
- you need to polyfill classlist (https://github.com/eligrey/classList.js/)
395393

396394
## Copyright
397395

0 commit comments

Comments
 (0)