Skip to content

Commit a56d746

Browse files
committed
Improved doc
1 parent 87ef4be commit a56d746

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/index.ngdoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

55
# Angular Screenfull
66

7+
Angular screenfull is a wrapper around the [Screenfull library](https://github.com/sindresorhus/screenfull.js/), that allows you to use the [HTML5 fullscreen API](https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Using_full_screen_mode), in "the Angular way".
78

8-
9-
Angular screenfull is a wrapper around the [Screenfull library](https://github.com/sindresorhus/screenfull.js/), it allows you to use the HTML5 fullscreen API in an Angular way.
9+
You can [fork it on github](https://github.com/hrajchert/angular-screenfull).
1010

1111
## Note on examples
1212

@@ -16,13 +16,13 @@ angular-animate and marked are not needed, but for some reason are added in the
1616

1717
#### Download via bower or look for the files in the dist folder
1818

19-
```
19+
```sh
2020
$ bower install --save angular-screenfull
2121
```
2222

2323
#### Import it to your page
2424

25-
```
25+
```html
2626
<script src="bower_components/screenfull/dist/screenfull.js"></script>
2727
<script src="bower_components/angular-screenfull/dist/angular-screenfull.min.js"></script>
2828
```
@@ -32,7 +32,7 @@ so if you use [main bower files](https://github.com/ck86/main-bower-files) the d
3232

3333
#### Enable it on your app
3434

35-
```
35+
```js
3636
angular.module('myApp', ['angularScreenfull']);
3737
```
3838

@@ -97,7 +97,7 @@ using this
9797
</file>
9898
</example>
9999

100-
# Show or hide elements
100+
# Show or hide
101101

102102
We also provide directives to show the elements based on the fullscreen status, so for example you can have this
103103

0 commit comments

Comments
 (0)