@geira/iconfont

# Geira Icons [![npm version](https://img.shields.io/npm/v/@geira/iconfont.svg)](https://www.npmjs.com/package/@geira/iconfont) [![pub package](https://img.shields.io/pub/v/geira_icons.svg)](https://pub.dev/packages/geira_icons) A clean, ligature-based icon font for web and Flutter. Browse all icons at [icons.geira.com](https://icons.geira.com). ## Installation ```bash npm install @geira/iconfont ``` ## Usage ### CSS Add the stylesheet inside your HTML `<head>`: ```html <link rel="stylesheet" href="node_modules/@geira/iconfont/dist/geira-icons.css"> ``` ### SCSS ```scss @use '@geira/iconfont/dist/geira-icons'; ``` ### Class-based (recommended) ```html ``` ### Ligature-based ```html pencil ``` ### Size modifiers ```html ``` ### Color modifiers ```html ``` ### Transform modifiers ```html ``` ## Flutter ```bash flutter pub add geira_icons ``` See the [pub.dev package](https://pub.dev/packages/geira_icons) for Flutter usage details. ## Development ### Setup ```bash git clone https://github.com/liontude/geira-icons-tool cd geira-icons-tool npm install cp .env.example .env # fill in SFTP credentials ``` ### Build ```bash npm run build ``` Reads `src/fonts/GeiraIcons-Regular.ttf`, syncs `tags.json`, and writes everything to `dist/`. ### Dev server ```bash npm run dev ``` Opens `http://localhost:3000`. Rebuilds automatically when the font or `tags.json` changes. ### Updating the font 1. Export from FontLab → TTF + WOFF2 + WOFF 2. Replace the three files in `src/fonts/` 3. `npm run build` If the build warns about icons with empty tags, edit `tags.json` and run `npm run build` again. ### Improving search tags Edit `tags.json`, then `npm run build`. ## Releasing ```bash npm run release:patch # 0.3.3 → 0.3.4 npm run release:minor # 0.3.3 → 0.4.0 npm run release:major # 0.3.3 → 1.0.0 ``` Each command bumps the version, builds, publishes to npm, and deploys the demo to icons.geira.com. After that, push the version commit and tag: ```bash git push && git push --tags ``` ## License The MIT License (MIT) Copyright (c) Liontude, LLC Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.