diff --git a/.gitignore b/.gitignore
index 907c78a..3d28264 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,29 +1,4 @@
-# Logs
-logs
-*.log
-
-# Runtime data
-pids
-*.pid
-*.seed
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-
-# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directory
-# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
node_modules
-
dist
+.tmp
+*.log
diff --git a/README.md b/README.md
index 98c2392..fcd5794 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# entypo
-411 carefully crafted premium pictograms by Daniel Bruce as a module. [entypo.com](http://www.entypo.com/) CC BY-SA 4.0.
+SVG sprite for the [Entypo+](http://entypo.com) icon collection.
[![npm][npm-image]][npm-url]
[![travis][travis-image]][travis-url]
@@ -16,8 +16,24 @@
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[standard-url]: http://npm.im/standard
+## About
+
+This is a [node](https://nodejs.org) module that packages the [Entypo+](http://entypo.com) icon collection as a SVG sprite.
+
+### What is Entypo?
+
+__411 carefully crafted premium pictograms by [Daniel Bruce](http://www.danielbruce.se/) - [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).__
+
` element](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/use).
+
+Read [Icon System with SVG Sprites](https://css-tricks.com/svg-sprites-use-better-icon-fonts/) by [Chris Coyier](http://chriscoyier.net/) for more information.
+
## Install
```
@@ -26,27 +42,487 @@ npm install entypo
## Usage
+### Basic
+
+```js
+const entypo = require('entypo')
+
+const sprite = entypo()
+
+document.body.innerHTML += sprite
+document.body.innerHTML += '
+ ${svg.id.replace('entypo-', '')}
+
+ `
+})
diff --git a/index.js b/index.js
index 604e9ec..b339e07 100644
--- a/index.js
+++ b/index.js
@@ -5,8 +5,7 @@ var spritePath = path.join(__dirname, 'dist', 'sprite.svg')
var svgPath = path.join(__dirname, 'Entypo+')
function main () {
- var svgSprite = fs.readFileSync(spritePath, 'utf8')
- return svgSprite
+ return fs.readFileSync(path.join(__dirname, 'dist', 'sprite.svg'), 'utf8')
}
function htmlToElement (html) {
diff --git a/package.json b/package.json
index 36990ec..c667dfa 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "entypo",
- "description": "411 carefully crafted premium pictograms by Daniel Bruce",
+ "description": "SVG sprite for the Entypo+ icon collection.",
"version": "1.0.2",
"author": "Bret Comnes ",
"bugs": {
@@ -30,15 +30,16 @@
"url": "https://github.com/hypermodules/entypo.git"
},
"scripts": {
- "test": "standard && tape test/*.js | tap-spec",
- "prepublish": "npm run build",
"build": "run-s clean optimize make-sprite clean:tmp",
- "make-sprite": "mkdirp dist && spritesh -i node_modules/.tmp -o dist/sprite.svg --prefix entypo-",
- "optimize": "run-p optimize:*",
- "optimize:base": "svgo -f Entypo+/Entypo+ -o node_modules/.tmp",
- "optimize:social": "svgo -f Entypo+/Entypo+\\ Social\\ Extension -o node_modules/.tmp",
"clean": "run-p clean:*",
- "clean:tmp": "rimraf node_modules/.tmp",
- "clean:dist": "rimraf dist"
+ "clean:dist": "rimraf dist",
+ "clean:tmp": "rimraf .tmp",
+ "example": "budo example.js --open --live -- -t brfs",
+ "make-sprite": "mkdirp dist && spritesh -i .tmp -o dist/sprite.svg --prefix entypo-",
+ "optimize": "run-p optimize:*",
+ "optimize:base": "svgo -f Entypo+/Entypo+ -o .tmp",
+ "optimize:social": "svgo -f Entypo+/Entypo+\\ Social\\ Extension -o .tmp",
+ "prepublish": "npm run build",
+ "test": "standard && tape test/*.js | tap-spec"
}
}
diff --git a/test/index.js b/test/index.js
index 9bf8e88..525b948 100644
--- a/test/index.js
+++ b/test/index.js
@@ -1,9 +1,11 @@
var test = require('tape')
var entypo = require('../')
-test('Example Test', function (t) {
- t.plan(3)
+test('API contract', function (t) {
t.equal(typeof entypo, 'function', 'main export is a function')
t.equal(typeof entypo.path, 'string', 'path exports a string')
t.equal(typeof entypo.rawPath, 'string', 'rawPath exports a string')
+ t.equal(typeof entypo.htmlToElement, 'function', 'htmlToElement exports a function')
+ t.equal(typeof entypo.getNode, 'function', 'getNode exports a function')
+ t.end()
})
+See [entypo.com](http://entypo.com) for more information.
+
+### What is a SVG sprite?
+
+A SVG sprite is a hidden SVG element inserted at the top of the body element that defines a set of icons with unique IDs. These icons can later be referenced throughout the document with the [`