assert-headers - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

CHANGELOG.md

@@ -7,2 +7,8 @@ # Changelog
 
+## [1.0.1] - 2021-05-24
+
+### Fixed
+
+- YAML configuration example in readme
+
 ## [1.0.0] - 2021-05-24
@@ -9,0 +15,0 @@

package.json

 {
   "name": "assert-headers",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Assert HTTP headers",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -49,3 +49,3 @@ # assert-headers-node
 
-`assert-headers` currently accepts configuration in JSON format. It allows specifying a schema for the headers, but also the outgoing origin and user-agent headers for the request. Below is an example configuration:
+`assert-headers` currently accepts configuration in JSON or YAML formats. It allows specifying a schema for the headers, but also the outgoing origin and user-agent headers for the request. Below is an example configuration:
 
@@ -68,3 +68,13 @@ ```json
 
-TODO: Allow yml configuration
+```yaml
+userAgent: "assert-headers-py"
+origin: "https://example.com"
+schema:
+  cache-control: False
+  strict-transport-security: True
+  x-content-type-options: "nosniff"
+  x-frame-options:
+    DENY: True
+    SAMEORIGIN: False
+```
 
@@ -71,0 +81,0 @@ **Schema Explanation:**

No alert changes

Improved metrics

Total package byte prevSize

20199

increased by1.43%

Number of lines in readme file

145

increased by7.41%

No dependency changes