Skip to content

Commit 039d9fd

Browse files
committed
πŸ“¦ prepare .jsons; πŸ“ .github
1 parent 4bf1c16 commit 039d9fd

File tree

5 files changed

+54
-12
lines changed

5 files changed

+54
-12
lines changed

β€Ž.github/contributing.mdβ€Ž

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
## Submitting issues
2+
3+
### Reduced test case required
4+
5+
All bug reports and problem issues require a [**reduced test case**](https://css-tricks.com/reduced-test-cases/) or **live URL**. Create one by forking any one of the [CodePen demos](https://codepen.io/desandro/tag/infinite-scroll-v3-docs) from [the docs](https://infinite-scroll.com).
6+
7+
+ A reduced test case clearly demonstrates the bug or issue.
8+
+ It contains the bare minimum HTML, CSS, and JavaScript required to demonstrate the bug.
9+
+ A link to your production site is **not** a reduced test case.
10+
11+
Providing a reduced test case is the best way to get your issue addressed. They help you point out the problem. They help me verify and debug the problem. They help others understand the problem. Without a reduced test case or live URL, your issue may be closed.
12+
13+
## Pull requests
14+
15+
Contributions are welcome! Please note: your code may be used as part of a commercial product if merged. Be clear about what license applies to your patch. [The MIT license](https://choosealicense.com/licenses/mit/) or [public domain unlicense](https://choosealicense.com/licenses/unlicense/) are permissive, and allow integration of your patch into Flickity as part of a commercial product.

β€Ž.github/issue_template.mdβ€Ž

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<!-- Thanks for submitting an issue! All bug reports and problem issues require a **reduced test case** or **live URL**. Create one by forking any one of the CodePen examples from the docs. See guidelines link above. -->
2+
3+
**Test case:** http://codepen.io/desandro/pen/azqbop

β€ŽREADME.mdβ€Ž

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,46 @@
11
# Infinite Scroll
22

3-
_Automatically add the next page_
3+
_Automatically add next page_
4+
5+
See [infinite-scroll.com](https://infinite-scroll.com) for complete docs and demos.
46

57
## Install
68

79
### Download
810

11+
- [infinite-scroll.pkgd.min.js](https://unpkg.com/infinite-scroll@3/dist/infinite-scroll.pkgd.min.js) minified, or
12+
- [infinite-scroll.pkgd.js](https://unpkg.com/infinite-scroll@3/dist/infinite-scroll.pkgd.js) un-minified
13+
914
### CDN
1015

16+
Link directly to Infinite Scroll files on [unpkg](https://unpkg.com).
17+
18+
``` html
19+
<script src="https://unpkg.com/infinite-scroll@3/dist/infinite-scroll.pkgd.min.js"></script>
20+
<!-- or -->
21+
<script src="https://unpkg.com/infinite-scroll@3/dist/infinite-scroll.pkgd.js"></script>
22+
```
23+
1124
### Package managers
1225

26+
npm: `npm install infinite-scroll`
27+
1328
Bower: `bower install infinite-scroll --save`
1429

30+
Yarn: `yarn add infinite-scroll`
31+
1532
## License
1633

1734
### Commercial license
1835

19-
If you want to use Infinite Scroll to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.
36+
If you want to use Infinite Scroll to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary. Purchase an Infinite Scroll Commercial License at [infinite-scroll.com](https://infinite-scroll.com/#commercial-license)
2037

2138
### Open source license
2239

2340
If you are creating an open source application under a license compatible with the [GNU GPL license v3](https://www.gnu.org/licenses/gpl-3.0.html), you may use Infinite Scroll under the terms of the GPLv3.
2441

42+
[Read more about Infinite Scroll's license](https://infinite-scroll.com/license.html).
43+
2544
## Usage
2645

2746
Infinite Scroll works on a container element with its child item elements
@@ -114,7 +133,7 @@ var infScroll = new InfiniteScroll( '.container', {
114133

115134
## WordPress plugin
116135

117-
The Infinite Scroll WordPress plugin is being moved to another repo.
136+
The Infinite Scroll WordPress plugin will be in development in a separate repo.
118137

119138
---
120139

β€Žbower.jsonβ€Ž

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,27 @@
1111
},
1212
"devDependencies": {
1313
"masonry": "^4.2.0",
14-
"imagesloaded": "^4.1.2",
14+
"imagesloaded": "^4.1.3",
1515
"jquery": "^3.2.1",
1616
"jquery-bridget": "^2.0.1",
1717
"qunit": "^2.3.2"
1818
},
1919
"keywords": [
20+
"infinite scroll",
2021
"infinite",
21-
"scroll"
22+
"scroll",
23+
"plugin"
2224
],
23-
"license": "GPLv3",
24-
"homepage": "",
25+
"license": "GPL-3.0",
26+
"homepage": "https://infinite-scroll.com",
2527
"ignore": [
2628
"**/.*",
2729
"node_modules",
2830
"bower_components",
2931
"test",
30-
"tests"
32+
"tests",
33+
"sandbox",
34+
"package.json",
35+
"gulpfile.js"
3136
]
3237
}

β€Žpackage.jsonβ€Ž

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "infinite-scroll",
3-
"version": "3.0.0-beta.1",
4-
"description": "Automatically add the next page",
3+
"version": "3.0.0",
4+
"description": "Automatically add next page",
55
"main": "js/index.js",
66
"files": [
77
"dist",
@@ -21,15 +21,15 @@
2121
"gulp-requirejs-optimize": "github:metafizzy/gulp-requirejs-optimize",
2222
"gulp-uglify": "^1.5.4",
2323
"gulp-util": "^3.0.8",
24-
"imagesloaded": "^4.1.2",
24+
"imagesloaded": "^4.1.3",
2525
"jquery": "^3.2.1",
2626
"jquery-bridget": "^2.0.1",
2727
"masonry-layout": "^4.2.0",
2828
"minimist": "^1.2.0",
2929
"qunitjs": "^2.3.2"
3030
},
3131
"scripts": {
32-
"test": "echo \"View test/ html\" && exit 1"
32+
"test": "echo \"View test/ in browser\" && exit 1"
3333
},
3434
"repository": {
3535
"type": "git",

0 commit comments

Comments
Β (0)