diff --git a/README.md b/README.md index b659f12..8e13e18 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,38 @@ # SVG2Fontify -## ๐Ÿšจ ๋ฌธ์ œ ์ •์˜ -๋ฆฌ์•กํŠธ์—์„œ SVG๋ฅผ ๊ฐ€์ ธ์˜ค๋Š” ๋ฐฉ๋ฒ• ์ค‘ ๋งŽ์ด ์“ฐ์ด๋Š” ๋ฐฉ๋ฒ•์ธ `SVG-in-JS` ๋ฐฉ๋ฒ•์€ ์‚ฌ์‹ค ์„ฑ๋Šฅ์ ์œผ๋กœ ์ข‹์ง€ ์•Š์Šต๋‹ˆ๋‹ค. -svg๋Š” ์ž๋ฐ”์Šคํฌ๋ฆฝํŠธ๊ฐ€ ์•„๋‹ˆ๋ผ ์ด๋ฏธ์ง€๋ฅผ ๋‚˜ํƒ€๋‚ด๋Š” html๊ณผ ์œ ์‚ฌํ•œ xmlํƒœ๊ทธ๋กœ, SVG ์ฝ”๋“œ๋ฅผ ์ž๋ฐ”์Šคํฌ๋ฆฝํŠธ ๋ฒˆ๋“ค ์•ˆ์— ๋„ฃ๊ฒŒ ๋œ๋‹ค๋ฉด ํŒŒ์‹ฑ๊ณผ ์ปดํŒŒ์ผ ๊ณผ์ •์„ ๊ฑฐ์น˜๊ฒŒ ๋˜์–ด ์ž๋ฐ”์Šคํฌ๋ฆฝํŠธ ์—”์ง„์ด ์†Œ์Šค์ฝ”๋“œ๋ฅผ ์ฒ˜๋ฆฌํ•˜๋Š” ์‹œ๊ฐ„์„ ๋” ์˜ค๋ž˜ ๊ฑธ๋ฆฌ๊ฒŒ ๋˜๋Š”๋ฐ์š”, ์ด๋Ÿฌํ•œ ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ•˜๊ธฐ ์œ„ํ•ด ``๋ฅผ ์‚ฌ์šฉํ•˜๊ฑฐ๋‚˜, SVG์— `use`๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๋ฐฉ๋ฒ•์„ ์“ฐ๊ฑฐ๋‚˜,`IconFont`๋กœ ๋ณ€ํ™˜ํ•˜์—ฌ ์‚ฌ์šฉํ•˜๋Š” ๋ฐฉ๋ฒ•๋“ค์ด ์žˆ์Šต๋‹ˆ๋‹ค.ย  +[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/abdelhakimrafik/icon2font/graphs/commit-activity) +[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/abdelhakimrafik/icon2font/blob/master/LICENSE) +[![TypeScript](https://badgen.net/badge/icon/typescript?icon=typescript&label)](https://typescriptlang.org) +[![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/abdelhakimrafik/icon2font/) -์ด์ค‘ `IconFont`๋ฅผ ์‚ฌ์šฉํ•˜๋Š” ๋ฐฉ๋ฒ•์„ ํƒํ•˜์˜€์„ ๋•Œ -1) Figma์—์„œ ๋””์ž์ด๋„ˆ๊ฐ€ ์ž‘์—…ํ•œ SVG๋ฅผ ์ฝ”๋“œํ™”ํ•˜์—ฌ ์ €์žฅํ•˜๊ณ , -2) Iconfont๋กœ ๋ณ€ํ™˜ํ•ด ์ฃผ๋Š” ์„œ๋น„์Šค๋ฅผ ์ด์šฉํ•˜์—ฌ , -3) ๋‹ค์‹œ ์ž‘์—… ํด๋”์— ์ €์žฅํ•˜๋Š” ๊ณผ์ •๋“ค์€ ๊ฝค๋‚˜ ๋ฒˆ๊ฑฐ๋กญ๊ณ  ์‹œ๊ฐ„์ ์ธ ๋น„์šฉ์ด ๋“œ๋Š” ์ž‘์—…์ž…๋‹ˆ๋‹ค. +Figma plugin to easily export icons to font and output a TTF/EOT/WOFF/SVG/CSS/SASS/TSX + +#### Features: + +- Supported font formats: `WOFF`, `WOFF2`, `EOT`, `TTF` and `SVG` +- Support Vue & `React` & `TypeScript` +- Support `Css` +- Provide `HTML Demo` +- Exports `Json` file for extra reuse +- Support custom `Fontname`, `Prefix`, `Suffix` +- Automatically generate a preview site + +## Usage + +1. Install Figma Plugin `SVG2Fontify` +1. Select icons to be exported +1. Run the plugin under plugins section +1. Fill inputs if needed (`Fontname`, `Prefix`, `Suffix`, `Delimiter`) [Optional] +1. Click `Generate` + +## Contributors + +This project exists thanks to all the people who contribute. + +## License + +Licensed under the [MIT License](https://opensource.org/licenses/MIT). -์ €ํฌ๋Š” ์ด๋Ÿฌํ•œ ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ•˜๊ณ ์ž Figma์—์„œ ์„ ํƒํ•œ SVG๋“ค์„ ๋ฐ”๋กœ Iconfont๋กœ ๋ณ€ํ™˜ํ•˜์—ฌ ์ €์žฅํ•˜์—ฌ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋Š” Figma ํ”Œ๋Ÿฌ๊ทธ์ธ์„ ๊ฐœ๋ฐœํ•˜์—ฌ ์ƒ์‚ฐ์„ฑ์„ ๋†’์ด๊ณ ์ž ํ–ˆ์Šต๋‹ˆ๋‹ค.ย  ## ๐Ÿงฉ ์š”๊ตฌ์‚ฌํ•ญ ๋ช…์„ธ ![image](https://hackmd.io/_uploads/rJOTrGEg0.png)