@ingredient-icons/core 0.1.0 → 0.1.1

package/README.md

@@ -9,13 +9,32 @@ npm install @ingredient-icons/core
 ```ts
 import { findIcon, iconName, iconUrl } from "@ingredient-icons/core"
 
-iconUrl("en:shallot")                 // https://cdn.jsdelivr.net/npm/@ingredient-icons/core@0.1.0/icons/webp/128/en_shallot.webp
+iconUrl("en:shallot")                 // https://cdn.jsdelivr.net/npm/@ingredient-icons/core@<version>/icons/webp/128/en_shallot.webp
 iconUrl("en:cherry-tomato", { size: 64 }) // the tomato's icon
 findIcon("en:cherry-tomato")          // { id: "en:tomato", file: "en_tomato", exact: false }
 iconName("en:shallot", "fr")          // "échalote"
 ```
 
-Icons ship as transparent WebP in 64, 128 and 256 px, under `icons/webp/{size}/`. URLs default to the jsDelivr CDN, pinned to the installed version; to serve the files yourself, expose the package's `icons/` folder and pass `{ baseUrl }`.
+Icons ship as transparent WebP in 64, 128 and 256 px, under `icons/webp/{size}/`. URLs default to the jsDelivr CDN, pinned to the installed version.
+
+## Serving the files yourself
+
+Expose the package's `icons/` folder and pass `{ baseUrl }`. With Express:
+
+```ts
+import { createRequire } from "node:module"
+import path from "node:path"
+import express from "express"
+import { iconUrl } from "@ingredient-icons/core"
+
+const root = path.dirname(createRequire(import.meta.url).resolve("@ingredient-icons/core/package.json"))
+const app = express()
+app.use("/ingredient-icons/icons", express.static(path.join(root, "icons"), { immutable: true, maxAge: "1y" }))
+
+iconUrl("en:shallot", { baseUrl: "https://api.example.com/ingredient-icons" })
+```
+
+An icon can change between versions: if you cache forever, put the package version (`VERSION`) in the path.
 
 ## Licenses
 

package/dist/data.d.ts

@@ -1,4 +1,4 @@
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.1.1";
 export declare const STYLE = 1;
 export declare const SIZES: readonly [64, 128, 256];
 export declare const TAXONOMY_COMMIT = "234008a0a245781a449c8dc975be3416fef1a3ef";

package/dist/data.js

@@ -1,5 +1,5 @@
 // Generated by scripts/generate.ts from manifest.json and taxonomy.json: do not edit.
-export const VERSION = "0.1.0";
+export const VERSION = "0.1.1";
 export const STYLE = 1;
 export const SIZES = [64, 128, 256];
 export const TAXONOMY_COMMIT = "234008a0a245781a449c8dc975be3416fef1a3ef";

package/dist/index.d.ts

@@ -21,7 +21,7 @@ export declare function findIcon(id: string): Icon | undefined;
 /** Path of an icon inside the package: "icons/webp/128/en_shallot.webp". */
 export declare function iconPath(id: string, size?: IconSize): string | undefined;
 /** Default CDN, pinned to this package's version so URLs never change under you. */
-export declare const CDN_URL = "https://cdn.jsdelivr.net/npm/@ingredient-icons/core@0.1.0";
+export declare const CDN_URL = "https://cdn.jsdelivr.net/npm/@ingredient-icons/core@0.1.1";
 /**
  * URL of an icon. Pass `baseUrl` to serve the package's `icons/` folder yourself
  * instead of the public CDN.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ingredient-icons/core",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Soft 3D icons for cooking ingredients, keyed by the Open Food Facts taxonomy, with ancestor fallback",
   "license": "(MIT AND CC0-1.0 AND ODbL-1.0)",
   "type": "module",