patroon 1.0.0 → 1.1.0

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.
Files changed (3) hide show
  1. package/README.md +11 -2
  2. package/README.mz +8 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -27,6 +27,7 @@ Pattern matching in JavaScript without additional syntax.
27
27
  + [NoMatchError](#nomatcherror)
28
28
  + [UnevenArgumentCountError](#unevenargumentcounterror)
29
29
  + [PatroonError](#patroonerror)
30
+ - [Examples](#examples)
30
31
  - [Tests](#tests)
31
32
  - [Contribute](#contribute)
32
33
  * [Contributors](#contributors)
@@ -555,6 +556,14 @@ isPatroonError(new UnevenArgumentCountError())
555
556
  patroon is causing an error
556
557
  ```
557
558
 
559
+ ## Examples
560
+
561
+ Patroon can be used in any context that can benefit from pattern matching.
562
+
563
+ - The following tests show how patroon can help you test your JSON API by
564
+ pattern matching on status codes and the body:
565
+ https://github.com/bas080/didomi/blob/master/index.test.js.
566
+
558
567
  ## Tests
559
568
 
560
569
  [./src/index.test.js][5] - Contains some tests for edge cases and it defines
@@ -574,7 +583,7 @@ npx nyc npm t | npx tap-nyc
574
583
  npx nyc check-coverage
575
584
  ```
576
585
  ```
577
- > patroon@1.0.0 test
586
+ > patroon@1.1.0 test
578
587
  > tape ./src/index.test.js
579
588
  -------------|---------|----------|---------|---------|-------------------
580
589
  File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s
@@ -588,7 +597,7 @@ npx nyc check-coverage
588
597
  total: 15
589
598
  passing: 15
590
599
 
591
- duration: 1s
600
+ duration: 1.4s
592
601
 
593
602
  ```
594
603
 
package/README.mz CHANGED
@@ -425,6 +425,14 @@ isPatroonError(new NoMatchError())
425
425
  isPatroonError(new UnevenArgumentCountError())
426
426
  ```
427
427
 
428
+ ## Examples
429
+
430
+ Patroon can be used in any context that can benefit from pattern matching.
431
+
432
+ - The following tests show how patroon can help you test your JSON API by
433
+ pattern matching on status codes and the body:
434
+ https://github.com/bas080/didomi/blob/master/index.test.js.
435
+
428
436
  ## Tests
429
437
 
430
438
  [./src/index.test.js][5] - Contains some tests for edge cases and it defines
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "patroon",
3
- "version": "1.0.0",
3
+ "version": "1.1.0",
4
4
  "description": "Pattern matching library",
5
5
  "repository": "github:bas080/patroon",
6
6
  "main": "./src/index.js",