1 | fur
|
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 | [![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
|
13 | [![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
|
14 | [![Dependency Status][bd_gemnasium_shield_url]][bd_gemnasium_url]
|
15 | [![npm Version][bd_npm_shield_url]][bd_npm_url]
|
16 | [![JS Standard][bd_standard_shield_url]][bd_standard_url]
|
17 |
|
18 | [bd_repo_url]: https://github.com/fur-repo/fur
|
19 | [bd_travis_url]: http://travis-ci.org/fur-repo/fur
|
20 | [bd_travis_shield_url]: http://img.shields.io/travis/fur-repo/fur.svg?style=flat
|
21 | [bd_license_url]: https://github.com/fur-repo/fur/blob/master/LICENSE
|
22 | [bd_codeclimate_url]: http://codeclimate.com/github/fur-repo/fur
|
23 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/fur-repo/fur.svg?style=flat
|
24 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/fur-repo/fur.svg?style=flat
|
25 | [bd_gemnasium_url]: https://gemnasium.com/fur-repo/fur
|
26 | [bd_gemnasium_shield_url]: https://gemnasium.com/fur-repo/fur.svg
|
27 | [bd_npm_url]: http://www.npmjs.org/package/fur
|
28 | [bd_npm_shield_url]: http://img.shields.io/npm/v/fur.svg?style=flat
|
29 | [bd_standard_url]: http://standardjs.com/
|
30 | [bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
|
31 |
|
32 |
|
33 |
|
34 |
|
35 |
|
36 | <a name="description"></a>
|
37 |
|
38 | Quick generator for banner, favicon, etc...
|
39 |
|
40 |
|
41 |
|
42 |
|
43 |
|
44 | <a name="overview"></a>
|
45 |
|
46 | <a href="https://github.com/fur-repo/fur#readme"><img style="height:128px;" src="doc/fur-banner.png" height="128"/></a>
|
47 |
|
48 | ```javascript
|
49 | // Generate favicon with command options.
|
50 | $ fur favicon "my-favicon.png" --color b --font n --text oh --shape c
|
51 | ```
|
52 |
|
53 |
|
54 |
|
55 |
|
56 |
|
57 |
|
58 |
|
59 | <a name="sections"></a>
|
60 |
|
61 |
|
62 |
|
63 | <a name="section-doc-gudies-02-howto-md"></a>
|
64 | Getting started
|
65 | ------
|
66 |
|
67 | ### Requirements
|
68 |
|
69 | + [node.js>=6][nodejs_url]
|
70 | + [phantomjs>=2.0.0](http://phantomjs.org/)
|
71 |
|
72 | ### Installation
|
73 |
|
74 | fur is available as an [npm][npm_url] package.
|
75 |
|
76 | ```bash
|
77 | # Install fur as a global module.
|
78 | $ npm install fur -g
|
79 | ```
|
80 |
|
81 | Or you can install it without `-g` option and use [Programmatic API](#programmatic-api).
|
82 |
|
83 | <a name="available commands"/>
|
84 | ### Available Commands
|
85 |
|
86 | ```bash
|
87 | $ fur -h
|
88 |
|
89 | Usage: fur [options] [command]
|
90 |
|
91 |
|
92 | Commands:
|
93 |
|
94 | banner [options] <filename> Generate a banner.
|
95 | favicon [options] <filename> Generate a favicon.
|
96 |
|
97 | Options:
|
98 |
|
99 | -h, --help output usage information
|
100 | -V, --version output the version number
|
101 |
|
102 |
|
103 | ```
|
104 |
|
105 | <a name="programmatic-api"/>
|
106 | ### Programmatic API
|
107 |
|
108 | fur provides programmatic API which enables you to execute fur commands from Node.js program.
|
109 |
|
110 | ```javascript
|
111 | var fur = require('fur');
|
112 | fur.banner('my-banner.svg', {
|
113 | text: "coz",
|
114 | color: "o",
|
115 | font: "aa",
|
116 | style: "plain",
|
117 | shape: "k"
|
118 | }, function (err) {
|
119 | });
|
120 | ```
|
121 |
|
122 |
|
123 | [nodejs_url]: https://nodejs.org/
|
124 | [npm_url]: https://www.npmjs.com
|
125 |
|
126 |
|
127 |
|
128 |
|
129 |
|
130 |
|
131 | <a name="section-doc-gudies-03-banners-md"></a>
|
132 | Generating Logo Banner
|
133 | ------------------
|
134 |
|
135 | ### Banner Examples
|
136 |
|
137 | | Image | Command |
|
138 | | ----- | ------- |
|
139 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/01-fur/banner.png" height="40" style="height:40px;"/> | ` $ fur banner "fur-banner.png" --text="FUR" --color="#ff9100" --font="bt" --shape="a" ` |
|
140 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/02-coz/banner.png" height="40" style="height:40px;"/> | ` $ fur banner "coz-banner.png" --text="coz" --color="#00b560" --font="aa" --shape="b" ` |
|
141 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/03-apeman/banner.png" height="40" style="height:40px;"/> | ` $ fur banner "apeman-banner.png" --text="apeman" --color="n" --font="p" --shape="a" ` |
|
142 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/04-pudding/banner.png" height="40" style="height:40px;"/> | ` $ fur banner "pudding-banner.png" --text="PUDDING" --color="bi" --font="cn" --shape="e" ` |
|
143 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/05-pon/banner.png" height="40" style="height:40px;"/> | ` $ fur banner "pon-banner.png" --text="pon" --color="ah" --font="ar" --shape="f" ` |
|
144 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/06-the/banner.png" height="40" style="height:40px;"/> | ` $ fur banner "the-banner.png" --text="the" --color="ac" --font="e" --shape="f" ` |
|
145 |
|
146 | These examples are available [here](https://github.com/fur-repo/fur-examples).
|
147 |
|
148 | ### Banner Usage
|
149 |
|
150 | ```bash
|
151 | $ fur banner -h
|
152 |
|
153 |
|
154 | Usage: banner [options] <filename>
|
155 |
|
156 | Generate a banner.
|
157 |
|
158 | Options:
|
159 |
|
160 | -h, --help output usage information
|
161 | -c, --color <color> Color expression string or color theme name.
|
162 | -s, --shape <shape> Banner style.
|
163 | -f, --font <font> Font file name or font theme name.
|
164 | -F, --font-size <fontSize> Size of font.
|
165 | -H, --height <height> Banner height.
|
166 | -o, --format <format> File format. 'svg' or 'png'.
|
167 | -t, --text <text> Banner text.
|
168 | -W, --width <width> Banner width.
|
169 | -v, --verbose Emit verbose log.
|
170 |
|
171 |
|
172 | ```
|
173 |
|
174 |
|
175 |
|
176 |
|
177 |
|
178 |
|
179 |
|
180 | <a name="section-doc-gudies-04-favicons-md"></a>
|
181 | Generating Favicon
|
182 | ------------------
|
183 |
|
184 | ### Favicon Examples
|
185 |
|
186 | | Image | Command |
|
187 | | ----- | ------- |
|
188 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/01-fur/favicon.png" height="40" style="height:40px;" /> | ` $ fur favicon "f-favicon.png" --text="F" --color="#ff9100" --font="bt" --shape="a" ` |
|
189 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/02-coz/favicon.png" height="40" style="height:40px;" /> | ` $ fur favicon "c-favicon.png" --text="c" --color="#00b560" --font="aa" --shape="c" ` |
|
190 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/03-apeman/favicon.png" height="40" style="height:40px;" /> | ` $ fur favicon "ap-favicon.png" --text="ap" --color="n" --font="p" --shape="g" ` |
|
191 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/04-pudding/favicon.png" height="40" style="height:40px;" /> | ` $ fur favicon "p-favicon.png" --text="P" --color="bi" --font="cn" --shape="a" ` |
|
192 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/05-pon/favicon.png" height="40" style="height:40px;" /> | ` $ fur favicon "pon-favicon.png" --text="pon" --color="ah" --font="ar" --shape="g" ` |
|
193 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/06-the/favicon.png" height="40" style="height:40px;" /> | ` $ fur favicon "the-favicon.png" --text="the" --color="ac" --font="e" --shape="c" --font-size="124" ` |
|
194 | | <img src="https://github.com/fur-repo/fur-examples/raw/master/example/08-apeman-app-contrib/favicon.png" height="40" style="height:40px;" /> | ` $ fur favicon "app-favicon.png" --text="app" --color="n" --font="p" --shape="i" --font-size="92" ` |
|
195 |
|
196 | These examples are available [here](https://github.com/fur-repo/fur-examples).
|
197 |
|
198 |
|
199 | ### Favicon Usage
|
200 |
|
201 | ```bash
|
202 | $ fur favicon -h
|
203 |
|
204 |
|
205 | Usage: favicon [options] <filename>
|
206 |
|
207 | Generate a favicon.
|
208 |
|
209 | Options:
|
210 |
|
211 | -h, --help output usage information
|
212 | -c, --color <color> Color expression string or color theme name.
|
213 | -f, --font <font> Font file name or font theme name.
|
214 | -F, --font-size <fontSize> Size of font.
|
215 | -S, --size <size> Favicon size.
|
216 | -s, --shape <shape> Banner style.
|
217 | -t, --text <text> Favicon text.
|
218 | -o, --format <format> File format. 'svg' or 'png'.
|
219 | -v, --verbose Emit verbose log.
|
220 |
|
221 |
|
222 | ```
|
223 |
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 | <a name="section-doc-gudies-05-themes-md"></a>
|
230 | Theme Gallery
|
231 | ------------
|
232 |
|
233 | + [Color Themes](http://fur-repo.github.io/fur-colors)
|
234 | + [Font Themes](http://fur-repo.github.io/fur-fonts)
|
235 | + [Shape Themes](http://fur-repo.github.io/fur-themes)
|
236 |
|
237 |
|
238 |
|
239 |
|
240 |
|
241 |
|
242 |
|
243 | <a name="section-doc-gudies-11-project-md"></a>
|
244 | About this project
|
245 | --------
|
246 |
|
247 | <a name="11-project-author"></a>
|
248 | ### Author
|
249 |
|
250 | + [Taka Okunishi](http://okunishitaka.com)
|
251 |
|
252 | <a name="11-project-donation"></a>
|
253 | ### Donation
|
254 |
|
255 | Support this project and [others by okunishinishi][my_gratipay_url] via [gratipay][my_gratipay_url].
|
256 |
|
257 | [<img src="https://cdn.rawgit.com/gratipay/gratipay-badge/2.3.0/dist/gratipay.svg" alt="Support via Gratipay"/>][my_gratipay_url]
|
258 |
|
259 |
|
260 |
|
261 | [my_gratipay_url]: https://gratipay.com/okunishinishi/
|
262 | [my_gratipay_budge_url]: http://img.shields.io/gratipay/okunishinishi.svg?style=flat
|
263 |
|
264 |
|
265 |
|
266 |
|
267 |
|
268 |
|
269 |
|
270 |
|
271 |
|
272 | <a name="license"></a>
|
273 |
|
274 | License
|
275 | -------
|
276 | This software is released under the [MIT License](https://github.com/fur-repo/fur/blob/master/LICENSE).
|
277 |
|
278 |
|
279 |
|
280 |
|
281 |
|
282 | <a name="links"></a>
|
283 |
|
284 | Links
|
285 | ------
|
286 |
|
287 | + [fur-examples](https://github.com/fur-repo/fur-examples)
|
288 | + [fur-colors](https://github.com/fur-repo/fur-colors)
|
289 | + [fur-fonts](https://github.com/fur-repo/fur-fonts)
|
290 | + [fur-shapes](https://github.com/fur-repo/fur-shapes)
|
291 |
|
292 |
|