fur-shapes/README.md

Shapes for fur.

fur-shapes
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/fur-labo/fur-shapes
[bd_travis_url]: http://travis-ci.org/fur-labo/fur-shapes
[bd_travis_shield_url]: http://img.shields.io/travis/fur-labo/fur-shapes.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/fur-labo/fur-shapes
[bd_travis_com_shield_url]: https://api.travis-ci.com/fur-labo/fur-shapes.svg?token=
[bd_license_url]: https://github.com/fur-labo/fur-shapes/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/fur-labo/fur-shapes
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/fur-labo/fur-shapes.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/fur-labo/fur-shapes.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/fur-labo/fur-shapes
[bd_gemnasium_shield_url]: https://gemnasium.com/fur-labo/fur-shapes.svg
[bd_npm_url]: http://www.npmjs.org/package/fur-shapes
[bd_npm_shield_url]: http://img.shields.io/npm/v/fur-shapes.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Shapes for fur.

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
npm install fur-shapes --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
----

```javascript
'use strict'

const furShapes = require('fur-shapes')
const fs = require('fs')

let themeA = furShapes.a(256, 215, '#38E')
let themeB = furShapes.b(512, 256, '#E00')

fs.writeFileSync('shape-01.svg', themeA)
fs.writeFileSync('shape-02.svg', themeB)

```

<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Examples.md.hbs" Start -->

<a name="section-doc-guides-03-examples-md"></a>

Examples
--------

See [fur-shapes-gallery](http://fur-repo.github.io/fur-shapes/)

| Theme | Image | Signature |
| :---: | ----- | --------- |
| **a** | <img src="./example/images/example-shape-a.png?v=2.1.2" height="62"> | `furShapes.a(256,256, #38E)` |
| **b** | <img src="./example/images/example-shape-b.png?v=2.1.2" height="62"> | `furShapes.b(256,256, #38E)` |
| **c** | <img src="./example/images/example-shape-c.png?v=2.1.2" height="62"> | `furShapes.c(256,256, #38E)` |
| **d** | <img src="./example/images/example-shape-d.png?v=2.1.2" height="62"> | `furShapes.d(256,256, #38E)` |
| **e** | <img src="./example/images/example-shape-e.png?v=2.1.2" height="62"> | `furShapes.e(256,256, #38E)` |
| **f** | <img src="./example/images/example-shape-f.png?v=2.1.2" height="62"> | `furShapes.f(256,256, #38E)` |
| **g** | <img src="./example/images/example-shape-g.png?v=2.1.2" height="62"> | `furShapes.g(256,256, #38E)` |
| **h** | <img src="./example/images/example-shape-h.png?v=2.1.2" height="62"> | `furShapes.h(256,256, #38E)` |
| **i** | <img src="./example/images/example-shape-i.png?v=2.1.2" height="62"> | `furShapes.i(256,256, #38E)` |
| **j** | <img src="./example/images/example-shape-j.png?v=2.1.2" height="62"> | `furShapes.j(256,256, #38E)` |


<!-- Section from "doc/guides/03.Examples.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/fur-labo/fur-shapes/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [fur][fur_url]
+ [fur-shapes-gallery][fur_shapes_gallery_url]

[fur_url]: https://github.com/fur-repo/fur
[fur_shapes_gallery_url]: http://fur-repo.github.io/fur-shapes/

<!-- Links End -->