@altrex-ui/icons 0.1.2 → 1.0.0

package/README.md

@@ -38,9 +38,9 @@ The library includes **1,585 icons** organized into three categories:
 
 | Category | Count | Prefix | Description |
 |----------|-------|--------|-------------|
-| **Free** | 556 icons | `cil-` | General-purpose UI icons (linear style) |
-| **Brand** | 830 icons | `cib-` | Company and product logos |
-| **Flag** | 199 icons | `cif-` | Country flags |
+| **Generic** | 556 icons | `generic-` | General-purpose UI icons (linear style) |
+| **Brand** | 830 icons | `brand-` | Company and product logos |
+| **Flag** | 199 icons | `flag-` | Country flags |
 
 ## Usage
 
@@ -51,19 +51,19 @@ The most efficient way to use icons in web applications. All 1,585 icons are inc
 #### HTML Usage
 
 ```html
-<!-- Free icons -->
+<!-- Generic icons -->
 <svg width="24" height="24">
-  <use href="node_modules/@altrex/icons/altrex.svg#cil-apple"/>
+  <use href="node_modules/@altrex/icons/altrex.svg#generic-apple"/>
 </svg>
 
 <!-- Brand icons -->
 <svg width="24" height="24">
-  <use href="node_modules/@altrex/icons/altrex.svg#cib-twitter"/>
+  <use href="node_modules/@altrex/icons/altrex.svg#brand-twitter"/>
 </svg>
 
 <!-- Flag icons -->
 <svg width="24" height="24">
-  <use href="node_modules/@altrex/icons/altrex.svg#cif-us"/>
+  <use href="node_modules/@altrex/icons/altrex.svg#flag-us"/>
 </svg>
 ```
 
@@ -81,7 +81,7 @@ Iconify format enables framework-agnostic icon usage and is compatible with popu
 
 ```javascript
 // ES Modules
-import freeIcons from '@altrex/icons/iconify/altrex-free.json';
+import genericIcons from '@altrex/icons/iconify/altrex-generic.json';
 import brandIcons from '@altrex/icons/iconify/altrex-brand.json';
 import flagIcons from '@altrex/icons/iconify/altrex-flag.json';
 ```
@@ -91,27 +91,27 @@ import flagIcons from '@altrex/icons/iconify/altrex-flag.json';
 **React:**
 ```jsx
 import { Icon } from '@iconify/react';
-import freeIcons from '@altrex/icons/iconify/altrex-free.json';
+import genericIcons from '@altrex/icons/iconify/altrex-generic.json';
 
 // Register icon set
 import { addCollection } from '@iconify/react';
-addCollection(freeIcons);
+addCollection(genericIcons);
 
 // Use icons
-<Icon icon="altrex-free:cil-apple" />
+<Icon icon="altrex-generic:generic-apple" />
 ```
 
 **Vue:**
 ```vue
 <template>
-  <Icon icon="altrex-free:cil-apple" />
+  <Icon icon="altrex-generic:generic-apple" />
 </template>
 
 <script setup>
 import { Icon, addCollection } from '@iconify/vue';
-import freeIcons from '@altrex/icons/iconify/altrex-free.json';
+import genericIcons from '@altrex/icons/iconify/altrex-generic.json';
 
-addCollection(freeIcons);
+addCollection(genericIcons);
 </script>
 ```
 
@@ -119,12 +119,12 @@ addCollection(freeIcons);
 ```svelte
 <script>
 import { Icon, addCollection } from '@iconify/svelte';
-import freeIcons from '@altrex/icons/iconify/altrex-free.json';
+import genericIcons from '@altrex/icons/iconify/altrex-generic.json';
 
-addCollection(freeIcons);
+addCollection(genericIcons);
 </script>
 
-<Icon icon="altrex-free:cil-apple" />
+<Icon icon="altrex-generic:generic-apple" />
 ```
 
 ### Direct Icon Access
@@ -135,7 +135,7 @@ All source SVG files are available in the [icons/](icons/) directory:
 
 ```
 icons/
-├── free/       # 556 SVG files
+├── generic/    # 556 SVG files
 ├── brand/      # 830 SVG files
 └── flag/       # 199 SVG files
 ```
@@ -147,9 +147,9 @@ Use [icons.json](icons.json) to programmatically access icon names:
 ```javascript
 import icons from '@altrex/icons/icons.json';
 
-console.log(icons.free);    // ["cil-3d", "cil-4k", "cil-account-logout", ...]
-console.log(icons.brand);   // ["cib-500px", "cib-abstract", ...]
-console.log(icons.flag);    // ["cif-ad", "cif-ae", ...]
+console.log(icons.generic);  // ["generic-3d", "generic-4k", "generic-account-logout", ...]
+console.log(icons.brand);    // ["brand-500px", "brand-abstract", ...]
+console.log(icons.flag);     // ["flag-ad", "flag-ae", ...]
 ```
 
 ## Build from Source
@@ -194,11 +194,11 @@ The build process follows these steps:
 ```
 altrex-icons/
 ├── icons/                          # Source SVG files (1,585 files)
-│   ├── free/                       # 556 free icons
+│   ├── generic/                    # 556 generic icons
 │   ├── brand/                      # 830 brand icons
 │   └── flag/                       # 199 flag icons
 ├── iconify/                        # Iconify JSON exports
-│   ├── altrex-free.json           # Free icons in Iconify format
+│   ├── altrex-generic.json        # Generic icons in Iconify format
 │   ├── altrex-brand.json          # Brand icons in Iconify format
 │   └── altrex-flag.json           # Flag icons in Iconify format
 ├── scripts/                        # Build scripts
@@ -220,7 +220,7 @@ After running `npm run build`, the following files are generated:
 |------|------|-------------|
 | [altrex.svg](altrex.svg) | ~4.8 MB | SVG sprite with all 1,585 icons |
 | [icons.json](icons.json) | ~31 KB | Icon inventory (categorized names) |
-| [iconify/altrex-free.json](iconify/altrex-free.json) | ~411 KB | Iconify JSON (free icons) |
+| [iconify/altrex-generic.json](iconify/altrex-generic.json) | ~411 KB | Iconify JSON (generic icons) |
 | [iconify/altrex-brand.json](iconify/altrex-brand.json) | ~1.4 MB | Iconify JSON (brand icons) |
 | [iconify/altrex-flag.json](iconify/altrex-flag.json) | ~3.3 MB | Iconify JSON (flag icons) |
 
@@ -228,9 +228,9 @@ After running `npm run build`, the following files are generated:
 
 Icons follow a consistent naming pattern:
 
-- **Free icons**: `cil-{name}` (e.g., `cil-apple`, `cil-airplane-mode`)
-- **Brand icons**: `cib-{name}` (e.g., `cib-twitter`, `cib-facebook`)
-- **Flag icons**: `cif-{code}` (e.g., `cif-us`, `cif-gb`, `cif-fr`)
+- **Generic icons**: `generic-{name}` (e.g., `generic-apple`, `generic-airplane-mode`)
+- **Brand icons**: `brand-{name}` (e.g., `brand-twitter`, `brand-facebook`)
+- **Flag icons**: `flag-{code}` (e.g., `flag-us`, `flag-gb`, `flag-fr`)
 
 ## Styling Icons
 
@@ -247,7 +247,7 @@ svg {
 ```html
 <!-- HTML -->
 <svg width="24" height="24">
-  <use href="altrex.svg#cil-apple"/>
+  <use href="altrex.svg#generic-apple"/>
 </svg>
 ```
 
@@ -314,16 +314,16 @@ The build scripts, configuration files, and distribution format are licensed und
 The icon artwork follows the original CoreUI Icons licensing:
 
 - **CoreUI Icons Free** (Linear icons) - CC BY 4.0 License
-  - All free icons (`cil-*` prefix) are licensed under Creative Commons Attribution 4.0
+  - All generic icons (`generic-*` prefix) are licensed under Creative Commons Attribution 4.0
   - You can use them for commercial and non-commercial projects
   - Attribution to CoreUI is appreciated but not required
 
-- **Brand Icons** (`cib-*` prefix)
+- **Brand Icons** (`brand-*` prefix)
   - Brand icons are trademarks of their respective owners
   - Use of these trademarks does not indicate endorsement
   - Only use brand logos to represent the actual company/product/service
 
-- **Flag Icons** (`cif-*` prefix)
+- **Flag Icons** (`flag-*` prefix)
   - Flag icons are in the public domain (CC0 1.0 Universal)
 
 For complete licensing details, see the [original CoreUI Icons repository](https://github.com/coreui/coreui-icons).