Skip to content

Commit 6a9c512

Browse files
committed
doc
1 parent 289147c commit 6a9c512

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This is a JavaScript/ECMA-262 implementation of **MessagePack**, an efficient bi
88

99
https://msgpack.org/
1010

11-
This library is a universal JavaScript, which suppors both browsers and NodeJS. In addition, because it is implemented in TypeScript, type definition files (`d.ts`) are bundled in the distribution.
11+
This library is a universal JavaScript, which suppors both browsers and NodeJS. In addition, because it is implemented in [TypeScript](https://www.typescriptlang.org/), type definition files (`d.ts`) are bundled in the distribution.
1212

1313
*Note that this is the second version of MessagePack for JavaScript. The first version, which was implemented in ES5 and was never released to npmjs.com, is tagged as [classic](https://github.com/msgpack/msgpack-javascript/tree/classic).*
1414

@@ -60,8 +60,9 @@ deepStrictEqual(decode(encoded), object);
6060
- [Benchmark](#benchmark)
6161
- [Distrubition](#distrubition)
6262
- [Maintenance](#maintenance)
63-
- [Testing](#testing)
64-
- [Relase Engineering](#relase-engineering)
63+
- [Testing](#testing)
64+
- [Continuous Integration](#continuous-integration)
65+
- [Release Engineering](#release-engineering)
6566
- [Updating Dependencies](#updating-dependencies)
6667
- [Big Thanks](#big-thanks)
6768
- [License](#license)
@@ -394,7 +395,17 @@ If you use NodeJS and/or webpack, their module resolvers use the suitable one au
394395

395396
## Maintenance
396397

397-
## Testing
398+
### Testing
399+
400+
For simple testing:
401+
402+
```
403+
npm run test
404+
```
405+
406+
### Continuous Integration
407+
408+
This library uses Travis CI.
398409

399410
test matrix:
400411

@@ -403,11 +414,11 @@ test matrix:
403414
* TypeScript targets
404415
* `target=es2019` / `target=es5`
405416
* JavaScript engines
406-
* NodeJS, borwsers (Chrome, Firefox, Safari, IE11)
417+
* NodeJS, borwsers (Chrome, Firefox, Safari, IE11, and so on)
407418

408419
See [test:* in package.json](./package.json) and [.travis.yml](./.travis.yml) for details.
409420

410-
### Relase Engineering
421+
### Release Engineering
411422

412423
```console
413424
# run tests on NodeJS, Chrome, and Firefox

0 commit comments

Comments
 (0)