Skip to content

Commit 9bf0ac9

Browse files
committed
update documentation
1 parent a7c8b6d commit 9bf0ac9

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ In Node environment or if you use a bundler (eg Webpack), the library also expor
3838
const immutableArrays = require('immutable-arrays');
3939
```
4040

41-
#### Import only the module you need
41+
#### Import only the module you need <sup>New in version 2.x.x</sup>
4242

4343
```js
4444
const push = require('immutable-arrays/dist/commonjs/push').default;
@@ -58,7 +58,7 @@ import immutableArrays from 'immutable-arrays';
5858
import { push } from 'immutable-arrays';
5959
```
6060

61-
#### Import only the module you need
61+
#### Import only the module you need <sup>New in version 2.x.x</sup>
6262

6363
```js
6464
import push from 'immutable-arrays/dist/commonjs/push';
@@ -276,13 +276,27 @@ const resultArray2 = immutableArrays.del(originalArray, -1);
276276
// -> resultArray2 ['a', 'b', 'c', 'd', 'e']
277277
```
278278

279-
## Test
279+
## For developers
280+
281+
### Build the library
282+
283+
```sh
284+
$ npm run dev
285+
```
286+
Builds the library and watches for changes while developing. If you want to build only for a specific format, there are other npm scripts available; check in `package.json`.
287+
288+
```sh
289+
$ npm run build
290+
```
291+
Builds the library for production.
292+
293+
### Run the tests
280294

281295
```sh
282-
$ npm test
296+
$ npm run test
283297
```
284298

285-
## Test Coverage
299+
### Tests coverage
286300

287301
```sh
288302
$ npm run coverage

0 commit comments

Comments
 (0)