From 88546299431be7c2d5b642849f75fd1dde70270e Mon Sep 17 00:00:00 2001 From: Alexandre Gigliotti Date: Wed, 5 Aug 2015 15:46:46 -0700 Subject: [PATCH] Updated README. --- README.md | 15 ++++++++------- package.json | 2 +- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e042c47..41bc2fc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # inline-html -Embed local assets into an HTML document. +Embed local assets in an HTML document. [![npm](https://img.shields.io/npm/v/inline-html.svg)]() [![Travis](https://img.shields.io/travis/panosoft/inline-html.svg)]() @@ -16,7 +16,6 @@ Embed local assets into an HTML document. This: var inlineHtml = require('inline-html'); - inlineHtml('path/to/file.html').then(function (html) { ... }); @@ -44,14 +43,14 @@ Into this: Where: -`main.less` +- `main.less` - @import (inline) 'main.css'; - div { background-image: url('path/to/file'); } + @import (inline) 'main.css'; + div { background-image: url('path/to/file'); } -`main.css` +- `main.css` - @font-face { src: url('path/to/file'); } + @font-face { src: url('path/to/file'); } ## API @@ -84,5 +83,7 @@ Returns a `Promise` that is fulfilled with an `html` string or a `results` objec #### Results object +The `Promise` returned by this function is optionally fulfilled with a `results` object that has the following properties: + - `html` - The inlined html - `files` - An array of filenames of the inlined local assets. diff --git a/package.json b/package.json index c53bb66..81d23e1 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "inline-html", "version": "0.1.1", - "description": "Inline an html file.", + "description": "Embed local assets in an HTML document.", "repository": "panosoft/inline-html", "main": "lib/index.js", "scripts": {