emdaer - npm Package Compare versions

Comparing version 0.1.1 to 0.2.0

docs/configuration.md

@@ -42,2 +42,27 @@ ## Configuration
 
+#### `image`
+type: `object`
+
+Details for an image to include in the README.
+
+##### `image.alt`
+type: `array`
+
+Alt text for the image
+
+##### `image.link`
+type: `string`
+
+An optional link to wrap the image.
+
+##### `image.path`
+type: `string`
+
+The path to the image.
+
+##### `image.position`
+type: `string`
+
+The alignment for the image (`'left'`, `'center'`, `'right'`).
+
 #### `license`
@@ -44,0 +69,0 @@ type: `string`

index.js

@@ -18,2 +18,16 @@ #! /usr/bin/env node
   },
+  image: ({ alt = '', link, path, position, width }) => {
+    const result = [];
+    result.push(`<img
+      src="${path}"
+      ${alt ? `alt="${alt}"` : ''}
+      align="${position}"
+      ${width ? `width="${width}"` : ''}
+    />`);
+    if (link) {
+      result.unshift(`<a href="${link}">`);
+      result.push('</a>');
+    }
+    return result.join('\n');
+  },
   include: ({ include = '' }) => {
@@ -20,0 +34,0 @@ let result;

package.json

 {
   "name": "emdaer",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "does a README.md",
@@ -5,0 +5,0 @@ "repository": "flipactual/emdaer",

README.md

@@ -1,3 +0,9 @@
-# emdaer
-
+<a href="https://github.com/flipactual/emdaer">
+<img
+      src="/docs/emdaer.png"
+      alt="emdaer"
+      align="right"
+      width="64px"
+    />
+</a>
 [![Travis](https://img.shields.io/travis/flipactual/emdaer.svg?style=flat-square)](https://travis-ci.org/flipactual/emdaer/)
@@ -70,2 +76,27 @@ [![Node](https://img.shields.io/node/v/emdaer.svg?style=flat-square)](http://npmjs.com/package/emdaer)
 
+#### `image`
+type: `object`
+
+Details for an image to include in the README.
+
+##### `image.alt`
+type: `array`
+
+Alt text for the image
+
+##### `image.link`
+type: `string`
+
+An optional link to wrap the image.
+
+##### `image.path`
+type: `string`
+
+The path to the image.
+
+##### `image.position`
+type: `string`
+
+The alignment for the image (`'left'`, `'center'`, `'right'`).
+
 #### `license`
@@ -72,0 +103,0 @@ type: `string`

No alert changes

Improved metrics

Total package byte prevSize

44542

increased by409.52%

Number of package files

9

increased by12.5%

Lines of code

77

increased by22.22%

Number of lines in readme file

167

increased by22.79%

No dependency changes