1 | fur-shapes
|
2 | ==========
|
3 |
|
4 |
|
5 | This file is generated by ape-tmpl. Do not update manually.
|
6 | --->
|
7 |
|
8 |
|
9 | <a name="badges"></a>
|
10 |
|
11 | [![Build Status][bd_travis_shield_url]][bd_travis_url]
|
12 | [![npm Version][bd_npm_shield_url]][bd_npm_url]
|
13 | [![JS Standard][bd_standard_shield_url]][bd_standard_url]
|
14 |
|
15 | [bd_repo_url]: https://github.com/fur-labo/fur-shapes
|
16 | [bd_travis_url]: http://travis-ci.org/fur-labo/fur-shapes
|
17 | [bd_travis_shield_url]: http://img.shields.io/travis/fur-labo/fur-shapes.svg?style=flat
|
18 | [bd_travis_com_url]: http://travis-ci.com/fur-labo/fur-shapes
|
19 | [bd_travis_com_shield_url]: https://api.travis-ci.com/fur-labo/fur-shapes.svg?token=
|
20 | [bd_license_url]: https://github.com/fur-labo/fur-shapes/blob/master/LICENSE
|
21 | [bd_codeclimate_url]: http://codeclimate.com/github/fur-labo/fur-shapes
|
22 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/fur-labo/fur-shapes.svg?style=flat
|
23 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/fur-labo/fur-shapes.svg?style=flat
|
24 | [bd_gemnasium_url]: https://gemnasium.com/fur-labo/fur-shapes
|
25 | [bd_gemnasium_shield_url]: https://gemnasium.com/fur-labo/fur-shapes.svg
|
26 | [bd_npm_url]: http://www.npmjs.org/package/fur-shapes
|
27 | [bd_npm_shield_url]: http://img.shields.io/npm/v/fur-shapes.svg?style=flat
|
28 | [bd_standard_url]: http://standardjs.com/
|
29 | [bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
|
30 |
|
31 |
|
32 |
|
33 |
|
34 |
|
35 | <a name="description"></a>
|
36 |
|
37 | Shapes for fur.
|
38 |
|
39 |
|
40 |
|
41 |
|
42 |
|
43 | <a name="overview"></a>
|
44 |
|
45 |
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 | <a name="sections"></a>
|
52 |
|
53 |
|
54 |
|
55 | <a name="section-doc-guides-01-installation-md"></a>
|
56 |
|
57 | Installation
|
58 | -----
|
59 |
|
60 | ```bash
|
61 | npm install fur-shapes --save
|
62 | ```
|
63 |
|
64 |
|
65 |
|
66 |
|
67 |
|
68 |
|
69 | <a name="section-doc-guides-02-usage-md"></a>
|
70 |
|
71 | Usage
|
72 | ----
|
73 |
|
74 | ```javascript
|
75 | 'use strict'
|
76 |
|
77 | const furShapes = require('fur-shapes')
|
78 | const fs = require('fs')
|
79 |
|
80 | let themeA = furShapes.a(256, 215, '#38E')
|
81 | let themeB = furShapes.b(512, 256, '#E00')
|
82 |
|
83 | fs.writeFileSync('shape-01.svg', themeA)
|
84 | fs.writeFileSync('shape-02.svg', themeB)
|
85 |
|
86 | ```
|
87 |
|
88 |
|
89 |
|
90 |
|
91 |
|
92 | <a name="section-doc-guides-03-examples-md"></a>
|
93 |
|
94 | Examples
|
95 | --------
|
96 |
|
97 | See [fur-shapes-gallery](http://fur-repo.github.io/fur-shapes/)
|
98 |
|
99 | | Theme | Image | Signature |
|
100 | | :---: | ----- | --------- |
|
101 | | **a** | <img src="./example/images/example-shape-a.png?v=2.1.2" height="62"> | `furShapes.a(256,256, #38E)` |
|
102 | | **b** | <img src="./example/images/example-shape-b.png?v=2.1.2" height="62"> | `furShapes.b(256,256, #38E)` |
|
103 | | **c** | <img src="./example/images/example-shape-c.png?v=2.1.2" height="62"> | `furShapes.c(256,256, #38E)` |
|
104 | | **d** | <img src="./example/images/example-shape-d.png?v=2.1.2" height="62"> | `furShapes.d(256,256, #38E)` |
|
105 | | **e** | <img src="./example/images/example-shape-e.png?v=2.1.2" height="62"> | `furShapes.e(256,256, #38E)` |
|
106 | | **f** | <img src="./example/images/example-shape-f.png?v=2.1.2" height="62"> | `furShapes.f(256,256, #38E)` |
|
107 | | **g** | <img src="./example/images/example-shape-g.png?v=2.1.2" height="62"> | `furShapes.g(256,256, #38E)` |
|
108 | | **h** | <img src="./example/images/example-shape-h.png?v=2.1.2" height="62"> | `furShapes.h(256,256, #38E)` |
|
109 | | **i** | <img src="./example/images/example-shape-i.png?v=2.1.2" height="62"> | `furShapes.i(256,256, #38E)` |
|
110 | | **j** | <img src="./example/images/example-shape-j.png?v=2.1.2" height="62"> | `furShapes.j(256,256, #38E)` |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
|
118 |
|
119 |
|
120 | <a name="license"></a>
|
121 |
|
122 | License
|
123 | -------
|
124 | This software is released under the [MIT License](https://github.com/fur-labo/fur-shapes/blob/master/LICENSE).
|
125 |
|
126 |
|
127 |
|
128 |
|
129 |
|
130 | <a name="links"></a>
|
131 |
|
132 | Links
|
133 | ------
|
134 |
|
135 | + [fur][fur_url]
|
136 | + [fur-shapes-gallery][fur_shapes_gallery_url]
|
137 |
|
138 | [fur_url]: https://github.com/fur-repo/fur
|
139 | [fur_shapes_gallery_url]: http://fur-repo.github.io/fur-shapes/
|
140 |
|
141 |
|