Skip to content

Commit

Permalink
Update README and node versions requirement (#52)
Browse files Browse the repository at this point in the history
* use jest instead of ava

* update readme about tests

* remove yarn.lock to stick with only package-lock

* update node version requirement

* update node versions for travis

* update node versions for travis
  • Loading branch information
gsantiago committed Aug 28, 2020
1 parent 24b1c3d commit 0180dc3
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 5,230 deletions.
5 changes: 2 additions & 3 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
language: node_js
node_js:
- "6"
- "7"
- "8"
- "10"
- "14"
after_success:
- npm run coverage
- npm run coveralls
14 changes: 5 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
[![npm version](https://badge.fury.io/js/subtitle.svg)](http://badge.fury.io/js/subtitle)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

Parse, manipulate and stringify SRT (SubRip) format. WebVTT as input is
Parse, manipulate and stringify SRT (SubRip) format. WebVTT as input is
also supported.

>["Thanks for this rad package!"](https://github.com/gsantiago/subtitle.js/pull/15#issuecomment-282879854)
>["Thanks for this rad package!"](https://github.com/gsantiago/subtitle.js/pull/15#issuecomment-282879854)
>John-David Dalton, creator of Lodash
## Installation
Expand Down Expand Up @@ -102,7 +102,7 @@ parse(mySrtOrVttContent)

The reverse of `parse`. It gets an array with subtitles and converts it to a valid SRT string.

The `stringifyVtt(captions: Array) -> String` function is also available for converting to a
The `stringifyVtt(captions: Array) -> String` function is also available for converting to a
valid WebVTT string.

```js
Expand Down Expand Up @@ -208,7 +208,7 @@ toVttTime(24400)

## Tests

Subtitle.js uses [AVA](https://github.com/avajs/ava) for running tests and [nyc](https://github.com/istanbuljs/nyc) for code coverage.
Subtitle.js uses Jest for tests.

If you want to run these tests, you need to install all devDependencies:

Expand All @@ -222,11 +222,7 @@ Now you can run the tests with the following command:

You can check the code coverage by running the following command:

`npm run coverage`

If you want a pretty HTML report, run the following:

`npm run report`
`npm run test:coverage`

Your report will be available in the `coverage` folder.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"stringify"
],
"engines": {
"node": ">= 6"
"node": ">= 10"
},
"author": "Guilherme Santiago",
"license": "MIT",
Expand Down
Loading

0 comments on commit 0180dc3

Please sign in to comment.