@archmap/icons 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +48 -0
- package/docs/ICON-CATALOG.md +1335 -0
- package/package.json +5 -1
package/README.md
CHANGED
|
@@ -6,6 +6,41 @@ ArchMap's `registerIcon()` mechanism.
|
|
|
6
6
|
|
|
7
7
|
## Usage
|
|
8
8
|
|
|
9
|
+
### Install
|
|
10
|
+
|
|
11
|
+
From npm, after publication:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @archmap/icons
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
From GitHub:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install github:ai-org-labs/archmap-icons
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
The GitHub install path runs `prepare`, so the TypeScript sources are built
|
|
24
|
+
into `dist/` during install.
|
|
25
|
+
|
|
26
|
+
For CDN-style browser imports, use an npm ESM CDN after the package is
|
|
27
|
+
published to npm:
|
|
28
|
+
|
|
29
|
+
```html
|
|
30
|
+
<script type="module">
|
|
31
|
+
import {
|
|
32
|
+
installCloudProviderIcons,
|
|
33
|
+
installFamousServiceIcons,
|
|
34
|
+
} from "https://esm.sh/@archmap/icons";
|
|
35
|
+
</script>
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Direct `unpkg`/`jsDelivr` file imports are not the recommended browser path
|
|
39
|
+
because this package intentionally uses ESM dependencies. Use an ESM CDN that
|
|
40
|
+
bundles dependencies, or install through npm.
|
|
41
|
+
|
|
42
|
+
### Register Icons
|
|
43
|
+
|
|
9
44
|
```ts
|
|
10
45
|
import { registerIcon } from "archmap";
|
|
11
46
|
import { installCloudProviderIcons, installFamousServiceIcons } from "@archmap/icons";
|
|
@@ -27,6 +62,19 @@ nodes:
|
|
|
27
62
|
App: { provider: azure, kind: app_services }
|
|
28
63
|
```
|
|
29
64
|
|
|
65
|
+
## Catalog
|
|
66
|
+
|
|
67
|
+
The full generated list is available in [docs/ICON-CATALOG.md](docs/ICON-CATALOG.md).
|
|
68
|
+
It includes common service keys, AWS/GCP/Azure `provider/kind` keys, titles,
|
|
69
|
+
categories, and aliases.
|
|
70
|
+
|
|
71
|
+
Regenerate it after source or generated cloud icon changes:
|
|
72
|
+
|
|
73
|
+
```bash
|
|
74
|
+
npm run build
|
|
75
|
+
npm run generate:catalog
|
|
76
|
+
```
|
|
77
|
+
|
|
30
78
|
## Cloud Provider Service Icons
|
|
31
79
|
|
|
32
80
|
AWS, Google Cloud, and Azure service icons are generated from the official SVG
|