@qius.solutions/parallel-ui-icons 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018-2026 Parallel UI
+
+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.

package/README.md

@@ -0,0 +1,83 @@
+# ParallelUI Icons
+
+A **web icon font** library used by the **Parallel UI** ecosystem. Artwork lives as SVGs in `raw-svg/`, is built with [Fantasticon](https://github.com/tancredi/fantasticon), and ships as CSS plus font files (TTF, WOFF, WOFF2, EOT, and SVG font), with the **`pi`** class prefix.
+
+There are **260 icons** today (UI, arrows, files, social, commerce, media, and more).
+
+---
+
+## Repository layout
+
+| Path | Description |
+|------|-------------|
+| `raw-svg/` | Source of truth: one `.svg` per icon (filename = icon name). |
+| `fonts/` | Generated output: `parallel-ui-icons.css`, font binaries, and helpers (`html`, `json`). |
+| `fantasticon.config.json` | Build settings (prefix `pi`, directories, formats). |
+| `site-doc/` | Static gallery **not published to npm**: search, category filters, light/dark theme, copy class name. |
+| `selection.json` | IcoMoon export (metadata / selection history); also omitted from the published package. |
+
+`package.json` exposes the stylesheet entry at `fonts/parallel-ui-icons.css` so `@font-face` URLs resolve correctly next to the font files.
+
+---
+
+## Install
+
+```bash
+npm install @qius.solutions/parallel-ui-icons
+```
+
+- [GitHub repository](https://github.com/qius-solutions/parallel-ui-icons)
+- [npm package](https://www.npmjs.com/package/@qius.solutions/parallel-ui-icons)
+
+---
+
+## Usage
+
+**1. Stylesheet (CDN or HTML)**
+
+```html
+<link rel="stylesheet" href="https://unpkg.com/@qius.solutions/parallel-ui-icons/fonts/parallel-ui-icons.css">
+```
+
+**2. Markup**
+
+Use any element with classes `pi` and `pi-<icon-name>` (the name matches the file in `raw-svg/`, e.g. `home` → `pi-home`):
+
+```html
+<i class="pi pi-home" aria-hidden="true"></i>
+```
+
+**3. Bundler (CSS import)**
+
+```js
+import '@qius.solutions/parallel-ui-icons/fonts/parallel-ui-icons.css';
+```
+
+Icon size follows the element’s `font-size` (or the parent’s), like any font glyph.
+
+---
+
+## Development and rebuilding the font
+
+Requirements: Node.js and npm.
+
+```bash
+npm install
+npm run build:icons
+```
+
+This runs Fantasticon with `fantasticon.config.json`, reads `./raw-svg`, and refreshes `./fonts` (`parallel-ui-icons.*`).
+
+To preview the local gallery, serve the **repository root** with a static server (so `site-doc/index.html` can resolve `../fonts/parallel-ui-icons.css`), for example:
+
+```bash
+npx serve .
+```
+
+Then open `/site-doc/index.html` in the browser.
+
+---
+
+## License
+
+[MIT](LICENSE)