@nib/buildkite-inline-image - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "@nib/buildkite-inline-image",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Provides an easy way to output inline images into your buildkite output log from node.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -8,1 +8,17 @@ # @nib/buildkite-inline-image
 Read more at the buildkite docs [here](https://buildkite.com/docs/builds/images-in-log-output).
+
+## Usage
+```javascript
+var buildkiteInlineImage = require('@nib/buildkite-inline-image');
+
+// Inline image from url
+var inlineImage = buildkiteInlineImage.inlineURLImage('https://github.com/nib-health-funds/node-buildkite-inline-image/blob/master/docs/inline_image_example.png');
+console.log(inlineImage);
+
+// Or, from an uploaded artifact
+var artifactFilePath = '/path/to/artifact.png';
+var inlineArtifactImage = buildkiteInlineImage.inlineArtifactImage(artifactFilePath);
+console.log(inlineArtifactImage);
+```
+The above would result in something similiar to the following output:
+![Usage example output](https://github.com/nib-health-funds/node-buildkite-inline-image/blob/master/docs/inline_image_example.png)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

115639

increased by5839.34%

Number of package files

4

increased by33.33%

Number of lines in readme file

24

increased by200%

No dependency changes