@brown-ds/distribution 0.0.43 → 0.0.44
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +39 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,11 +2,49 @@
|
|
|
2
2
|
|
|
3
3
|
This is the distribution library. When loaded, distribution introduces functionality supporting the distributed execution of programs. To download it:
|
|
4
4
|
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
5
7
|
```sh
|
|
6
8
|
$ npm i '@brown-ds/distribution'
|
|
7
9
|
```
|
|
8
10
|
|
|
9
|
-
This command downloads and installs the distribution library
|
|
11
|
+
This command downloads and installs the distribution library.
|
|
12
|
+
|
|
13
|
+
## Testing
|
|
14
|
+
|
|
15
|
+
There are several categories of tests:
|
|
16
|
+
* Regular Tests (`*.test.js`)
|
|
17
|
+
* Scenario Tests (`*.scenario.js`)
|
|
18
|
+
* Extra Credit Tests (`*.extra.test.js`)
|
|
19
|
+
|
|
20
|
+
By default, tests excluding those with non-distribution in their names are run. Use the options below to control the test suite:
|
|
21
|
+
|
|
22
|
+
### Running Tests
|
|
23
|
+
|
|
24
|
+
1. Run all regular tests (default):
|
|
25
|
+
```sh
|
|
26
|
+
$ npm test
|
|
27
|
+
```
|
|
28
|
+
2. Run scenario tests:
|
|
29
|
+
```sh
|
|
30
|
+
$ npm test -- -c
|
|
31
|
+
```
|
|
32
|
+
3. Run extra credit tests:
|
|
33
|
+
```sh
|
|
34
|
+
$ npm test -- -ec
|
|
35
|
+
```
|
|
36
|
+
4. Run the `non-distribution` tests:
|
|
37
|
+
```sh
|
|
38
|
+
$ npm test -- -n
|
|
39
|
+
```
|
|
40
|
+
5. Combine options:
|
|
41
|
+
```sh
|
|
42
|
+
$ npm test -- -c -ec -n
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Usage
|
|
46
|
+
|
|
47
|
+
To import the library, be it in a JavaScript file or on the interactive console, run:
|
|
10
48
|
|
|
11
49
|
```js
|
|
12
50
|
let distribution = require("@brown-ds/distribution");
|