Skip to content

Commit 8b42377

Browse files
committed
readme linting
1 parent 3aeb6f5 commit 8b42377

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ the best way to get started is to check out the examples folder, start with [sim
6161

6262
As of now (25.05.2019) the web audio api typings seems to be included in lib.d.ts, so removing them from package.json:
6363

64-
```
64+
```json
6565
"dependencies": {
6666
"@types/webaudioapi": "0.0.27"
6767
},
@@ -75,8 +75,8 @@ the current [dom.d.ts on github](https://github.com/microsoft/TypeScript/blob/ma
7575

7676
TSlint will be deprecated [github ticket](https://github.com/palantir/tslint/issues/4534)
7777

78-
> we plan to deprecate TSLint and focus our efforts instead on improving ESLint’s TypeScript support
79-
78+
> we plan to deprecate TSLint and focus our efforts instead on improving ESLint’s TypeScript support
79+
8080
Their [blog post](https://medium.com/palantir/tslint-in-2019-1a144c2317a9) announcing that [TSLint](https://github.com/palantir/tslint) will be deprecated in 2019 and you should switch to [ESLint](https://github.com/eslint/eslint) when TSLint is officially deprecated
8181

8282
## TODOs (help wanted 😊)
@@ -87,7 +87,7 @@ Their [blog post](https://medium.com/palantir/tslint-in-2019-1a144c2317a9) annou
8787
* write more documentation
8888
* add a contribution guide
8989
* write tests!!! (goal 100% coverage), add [tests coverage badge](https://coveralls.io)
90-
* [abort](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/abort) the loading of the sound if the user clicks play and then pause (or stop / next / previous) before the end of the buffering process
90+
* [abort](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/abort) the loading of the sound if the user clicks play and then pause (or stop / next / previous) before the end of the buffering process
9191
* allow cross fading songs "on end" if it's the next song in a playlist
9292
* currently the "find song in queue" can't retrieve songs by queue index, is this useful anyway?
9393
* implement suspend and resume: ctx.suspend() and resume of the context on pause / stop or if for some time no sound was played? ... to free device resources, as suspend returns a promise, does this mean suspending and resuming takes time? if so how much time does it take, based on that information we can decide when and how often we should resume / suspend
@@ -99,8 +99,8 @@ Their [blog post](https://medium.com/palantir/tslint-in-2019-1a144c2317a9) annou
9999
* add a loop song and loop queue mode
100100
* handle all error cases that are still unhandled
101101
* add support for more codecs (flac, wav, ogg vorbis, opus, aac): also check the available codecs and defined sources, play the first one that has matches and available codec, let user define order of preferred codecs for playerback
102-
* add [browser compatibility table badge](https://saucelabs.com/blog/new-open-sauce-ui-and-refreshed-build-status-badges) in readme
103-
* add [travis](https://travis-ci.org) build check and badge
102+
* add [browser compatibility table badge](https://saucelabs.com/blog/new-open-sauce-ui-and-refreshed-build-status-badges) in readme
103+
* add [travis](https://travis-ci.org) build check and badge
104104
* add UI screenshot to readme
105105
* add demo (github pages)
106106
* for position and volume, allow to use a percentage or a value

0 commit comments

Comments
 (0)