y-icons 0.1.0 → 0.1.1

package/README.md

@@ -1,43 +1,20 @@
 # y-icons
 
-MDI に不足するアイコンを **簡単に作って・簡単に使う** ための独自アイコンパッケージ。
+MDI に不足するアイコンを補う独自アイコンパッケージ。1 つの SVG から
+**Vue/Vuetify・HTML/CSS・Figma** の 3 経路で使える（MDI 互換：24dp グリッド・単一 `<path>`・`currentColor`）。
 
-**1 つの真実の源（`icons/` 配下の SVG）** から、Vue/Vuetify・Web/ERB・Figma の **3 経路すべて** を
-自動生成・配布する。
-
-```
-icons/<name>.svg  ← 真実の源（SoT）。1 枚置くだけ
-        │  npm run build
-        ├─ コード(Vuetify) … y: アイコンセット（<v-icon icon="y:name"> など全 icon プロパティ）
-        ├─ コード(Web/ERB) … アイコンフォント（<i class="yicon yicon-name">）
-        ├─ Figma          … Storybook からコピー＆ペースト（グリフ or SVG）
-        └─ 安定コードポイント（codepoints.json・追記専用）
-```
+[![npm](https://img.shields.io/npm/v/y-icons.svg)](https://www.npmjs.com/package/y-icons)
 
 ---
 
-## クイックスタート
+## インストール
 
 ```bash
-npm install
-npm run build        # build:set + build:font + tsc
-
-npm run storybook    # ギャラリー・候補・利用例・フォントDL を閲覧
+npm install y-icons      # または yarn add y-icons
 ```
 
 ---
 
-## アイコンを追加する
-
-1. **作る**：`icons/<name>.svg` を置く。
-   - デザイナーは Figma で作図 → SVG 書き出し（下記「設計仕様」準拠）。
-   - 開発者は **`/create-icon <要望>`** スキルで AI 叩き台を 10 案生成 → Storybook `icons/Candidates` で
-     MDI と見比べて選定 → `icons/` へ昇格。
-2. **ビルド**：`npm run build`（`build:set` が仕様＋バウンディングボックスを検証）。
-3. **配布**：CI がフォント／npm を生成・配布（後述）。
-
----
-
 ## 使い方（3 経路）
 
 ### 1. Vue / Vuetify
@@ -54,80 +31,53 @@ createVuetify({ icons: vuetifyIcons })
 <v-btn :icon="'y:inventory-transfer'" />
 ```
 
-FW 非依存に使う場合：`import { yIconPaths } from 'y-icons'` ／ 個別 SVG は `y-icons/svg/<name>.svg`。
-
-### 2. Web の生 class / Rails ERB（Vuetify を介さない場所）
+既存の `mdi` セットと共存する（`mdi-*` はそのまま、`y:` が独自アイコン）。
 
-`dist/font/y-icons.css` を読み込み：
+FW 非依存に使う場合：
 
-```html
-<i class="yicon yicon-inventory-transfer"></i>           <!-- クラス -->
-<span class="yicon">inventory-transfer</span>             <!-- 名前リガチャ（ブラウザのみ） -->
+```ts
+import { yIconPaths, yIconNames } from 'y-icons'  // name→d の map ／ 名前一覧
 ```
 
-### 3. Figma（Storybook からコピー＆ペースト）
+個別の生 SVG は `y-icons/svg/<name>.svg` から参照できる。
 
-Storybook `icons/CustomIcons` の各アイコンに 2 つのコピーボタン。MDI(pictogrammers) と同じ運用：
+### 2. プレーン HTML / CSS（アイコンフォント）
 
-| ボタン | コピー内容 | Figma 結果 | フォント要否 |
-|---|---|---|---|
-| **グリフをコピー** | PUA 文字＋`font-family: y-icons` | テキスト（y-icons フォント）= MDI の Copy Glyph と同じ | **要インストール** |
-| **SVGをコピー** | `<svg fill="currentColor">` | ベクター図形 | 不要 |
+Vuetify を介さない場所（素の HTML、各種テンプレートエンジン等）では、同梱の
+`y-icons/font/y-icons.css`（フォント実体 `y-icons.woff2` なども `y-icons/font/` に同梱）を読み込み：
 
-フォントは `icons/DownloadFont` ストーリーからダウンロードしてインストール。
-詳細なデザイナー手順は [`docs/figma-guide.md`](docs/figma-guide.md)。
+```html
+<i class="yicon yicon-inventory-transfer"></i>      <!-- クラス -->
+<span class="yicon">inventory-transfer</span>        <!-- 名前リガチャ（ブラウザのみ） -->
+```
 
-> Figma のリガチャ（名前を打つと変換）は信頼性が低いため使わない。リガチャは Web/ERB（ブラウザ）専用。
+### 3. Figma
 
----
+アイコンフォントをインストールして使う（MDI(pictogrammers) と同じ運用）：
 
-## Storybook（運用の入口）
+| 方法 | Figma 結果 | フォント要否 |
+|---|---|---|
+| **グリフを貼り付け** | テキスト（`font-family: y-icons` ＋ PUA 文字）でアイコン表示 | **要インストール** |
+| **SVG を貼り付け** | ベクター図形（`<svg fill="currentColor">`） | 不要 |
 
-| ストーリー | 役割 |
-|---|---|
-| `icons/CustomIcons` | 一覧 ＋ グリフ/SVG コピー（Figma 貼付） |
-| `icons/Candidates` | 候補プレビュー ＋ MDI 参照（採点） |
-| `icons/VuetifyUsage` | `y:` が全 Vuetify icon プロパティで効く実証 |
-| `icons/DownloadFont` | フォント一式（ttf/woff/css/cheatsheet）を DL |
+フォント実体（`y-icons.ttf` / `.woff` / `.woff2`）とチートシート（`y-icons.html`）は
+パッケージの `y-icons/font/` 配下、または [GitHub Releases](https://github.com/hamayou-61/y-icons/releases) から入手できる。
 
 ---
 
-## 設計仕様（Material Design アイコン規格準拠：24dp グリッド／キーライン）
+## 設計仕様（参考）
+
+収録アイコンは Material Design アイコン規格（24dp グリッド／キーライン）に準拠：
 
 | 項目 | 値 |
 |---|---|
 | グリッド | 24×24 dp（viewBox `0 0 24 24` 固定） |
 | ライブエリア / 余白 | 中身 ~20×20dp（座標 2〜22）、外周 2dp padding |
-| ストローク幅 | 2dp（2dp 以下は角を丸めない） |
-| 角丸 | 既定 2dp |
-| キーラインシェイプ | 円⌀20 / 正方形18 / 縦長16×20 / 横長20×16 |
-
-形式：**単一 `<path>`**（`<g>`・`transform`・複数 path 不可）／**`fill` を書かない**（`currentColor`）／
-`stroke` 不使用（中空は外形＋内形の逆回りサブパス、帯幅 2dp 一貫）／座標 0.5dp 刻み。
-`npm run build:set` が SVGO 正規化＋仕様＋bbox を検証（違反で停止）。
-
----
-
-## 成果物とリポ構成
-
-| パス | 内容 |
-|---|---|
-| `icons/*.svg` | **SoT**（デザイナーが置く） |
-| `candidates/*.svg` | 採用前の候補（`/create-icon` が書き込む下書き） |
-| `src/registry.generated.ts` | 自動生成（name→d） |
-| `src/vuetify.ts` | Vuetify アダプタ（`vuetifyIcons` / `yIconSet`） |
-| `scripts/build-set.mjs` / `build-font.mjs` | 生成（registry/svg ・ フォント） |
-| `dist/` | 配布物（gitignore。CI/publish 時に生成） |
-| `codepoints.json` | 名前→コードポイントの固定割当（**コミット対象・追記専用**） |
-
-`package.json` の exports：`.`（FW 非依存）／`./vuetify`／`./font/*`／`./svg/*`。
+| ストローク幅 | 2dp（中空は外形＋内形の逆回りサブパスで表現） |
+| 形式 | 単一 `<path>` ／ `fill` を書かない（`currentColor`） |
 
 ---
 
-## CI
-
-- **push / PR**（`.github/workflows/ci.yml`）：`npm run build` ＋ **生成物ドリフト検査** ＋
-  **アイコンフォントを成果物としてアップロード**（各実行からダウンロード可）。
-- **Release 公開**（`.github/workflows/release.yml`）：`y-icons` を publish ＋ フォントを Releases に添付。
+## ライセンス
 
-稼働前 TODO：registry 確定（GitHub Packages 等）、`package.json` の `private` 解除＋`publishConfig` 設定。
+[MIT](LICENSE)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "y-icons",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "独自アイコン（MDI互換）。単一の真実の源（icons/ 配下のSVG群）から、Vue/Vuetify用アイコンセット・生SVG/d-map・Figma用アイコンフォントを生成・配布する。",
   "type": "module",
   "license": "MIT",