Skip to content

Commit ba57e14

Browse files
committed
Merge branch 'develop' of https://github.com/k3nsei/ng-in-viewport into develop
2 parents 097c379 + 5f1a716 commit ba57e14

File tree

3 files changed

+45
-30
lines changed

3 files changed

+45
-30
lines changed

README.md

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
<!-- Badges section here. -->
44
[![CircleCI Status][circle-ci-badge]][circle-ci-badge-url]
5+
[![Maintainability][codeclimate-maintainability-badge]][codeclimate-maintainability-badge-url]
6+
[![Test Coverage][codeclimate-coverage-badge]][codeclimate-coverage-badge-url]
7+
[![codebeat badge][codebeat-badge]][codebeat-badge-url]
8+
[![Greenkeeper badge][greenkeeper-badge]][greenkeeper-badge-url]
9+
510
[![Dependency Status][david-badge]][david-badge-url]
611
[![peerDependency Status][david-peer-badge]][david-peer-badge-url]
712
[![devDependency Status][david-dev-badge]][david-dev-badge-url]
@@ -12,26 +17,9 @@
1217

1318
Allows us to check if an element is within the browsers visual viewport
1419

15-
## Install
16-
17-
Install with yarn:
18-
19-
```sh
20-
yarn add ng-in-viewport intersection-observer
21-
```
22-
23-
I'm using yarn but you can use npm if you like:
24-
25-
```sh
26-
npm install --save ng-in-viewport intersection-observer
27-
```
28-
29-
## Demo
30-
[Here][example-app] you can look at our example application
31-
32-
## Simple usage example
33-
34-
ToDo: Fill this with some example
20+
- 🤓 Learn about it on the [DOCS Site][lib-docs]
21+
- 🚀 See it in action on [Stackblitz][example-app]
22+
- 🎮 Play with it on [Stackblitz][example-app-embed]
3523

3624
## License
3725

@@ -40,18 +28,34 @@ ToDo: Fill this with some example
4028
[circle-ci-badge]: https://circleci.com/gh/k3nsei/ng-in-viewport/tree/master.svg?style=shield&circle-token=1c961beeff7d2e03a4203efd1858081b9901caac
4129
[circle-ci-badge-url]: https://circleci.com/gh/k3nsei/ng-in-viewport/tree/master
4230

43-
[david-badge]: https://david-dm.org/k3nsei/ng-in-viewport.svg
44-
[david-badge-url]: https://david-dm.org/k3nsei/ng-in-viewport
31+
[codeclimate-maintainability-badge]: https://api.codeclimate.com/v1/badges/a9c4480075e536498c72/maintainability
32+
[codeclimate-maintainability-badge-url]: https://codeclimate.com/github/k3nsei/ng-in-viewport/maintainability
33+
34+
[codeclimate-coverage-badge]: https://api.codeclimate.com/v1/badges/a9c4480075e536498c72/test_coverage
35+
[codeclimate-coverage-badge-url]: https://codeclimate.com/github/k3nsei/ng-in-viewport/test_coverage
36+
37+
[codebeat-badge]: https://codebeat.co/badges/73e483ff-fb24-4ad1-9878-89aa1ed55192
38+
[codebeat-badge-url]: https://codebeat.co/projects/github-com-k3nsei-ng-in-viewport-develop
4539

46-
[david-peer-badge]: https://david-dm.org/k3nsei/ng-in-viewport/peer-status.svg
47-
[david-peer-badge-url]: https://david-dm.org/k3nsei/ng-in-viewport?type=peer
40+
[greenkeeper-badge]: https://badges.greenkeeper.io/k3nsei/ng-in-viewport.svg
41+
[greenkeeper-badge-url]: https://greenkeeper.io/
4842

49-
[david-dev-badge]: https://david-dm.org/k3nsei/ng-in-viewport/dev-status.svg
50-
[david-dev-badge-url]: https://david-dm.org/k3nsei/ng-in-viewport?type=dev
43+
[david-badge]: https://david-dm.org/k3nsei/ng-in-viewport/develop.svg?path=projects/ng-in-viewport
44+
[david-badge-url]: https://david-dm.org/k3nsei/ng-in-viewport/develop?path=projects/ng-in-viewport
45+
46+
[david-peer-badge]: https://david-dm.org/k3nsei/ng-in-viewport/develop/peer-status.svg?path=projects/ng-in-viewport
47+
[david-peer-badge-url]: https://david-dm.org/k3nsei/ng-in-viewport/develop?type=peer&path=projects/ng-in-viewport
48+
49+
[david-dev-badge]: https://david-dm.org/k3nsei/ng-in-viewport/develop/dev-status.svg?path=projects/ng-in-viewport
50+
[david-dev-badge-url]: https://david-dm.org/k3nsei/ng-in-viewport/develop?type=dev&path=projects/ng-in-viewport
5151

5252
[npm-badge-version]: https://img.shields.io/npm/v/ng-in-viewport.svg
5353
[npm-badge-license]: https://img.shields.io/npm/l/ng-in-viewport.svg
5454
[npm-badge-downloads]: https://img.shields.io/npm/dm/ng-in-viewport.svg
5555
[npm-badge-url]: https://www.npmjs.com/package/ng-in-viewport
5656

57+
[lib-docs]: https://k3nsei.gitbook.io/ng-in-viewport/
58+
[api-docs]: https://k3nsei.github.io/ng-in-viewport/
59+
5760
[example-app]: https://ng-in-viewport-example.stackblitz.io/
61+
[example-app-embed]: https://stackblitz.com/edit/ng-in-viewport-example?embed=1&file=src/main.ts

greenkeeper.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"groups": {
3+
"default": {
4+
"packages": [
5+
"package.json",
6+
"projects/ng-in-viewport/ng-package.json",
7+
"projects/ng-in-viewport/package.json"
8+
]
9+
}
10+
}
11+
}

package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@
6969
"@angular/language-service": "^6.0.5",
7070
"@types/jasmine": "~2.8.6",
7171
"@types/jasminewd2": "~2.0.3",
72-
"@types/node": "~10.3.4",
72+
"@types/node": "~10.5.0",
7373
"codelyzer": "~4.3.0",
7474
"express": "^4.16.3",
7575
"http-server": "^0.11.1",
@@ -81,17 +81,17 @@
8181
"karma-jasmine": "~1.1.1",
8282
"karma-jasmine-html-reporter": "^1.1.0",
8383
"ng-packagr": "^3.0.0",
84-
"prettier": "1.13.5",
84+
"prettier": "1.13.6",
8585
"protractor": "~5.3.0",
8686
"reflect-metadata": "^0.1.12",
8787
"rimraf": "^2.6.2",
8888
"ts-loader": "^4.3.0",
89-
"ts-node": "~6.1.1",
89+
"ts-node": "~6.2.0",
9090
"tsickle": ">=0.25.5",
9191
"tslib": "^1.7.1",
9292
"tslint": "~5.10.0",
9393
"typedoc": "^0.11.1",
94-
"typescript": "~2.7.2",
94+
"typescript": ">=2.7.2 <2.8.0",
9595
"webpack-cli": "^3.0.8"
9696
},
9797
"resolutions": {

0 commit comments

Comments
 (0)