@shumoku/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 +64 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
# @shumoku/icons
|
|
2
|
+
|
|
3
|
+
Vendor-specific icons for Shumoku network diagrams.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @shumoku/icons @shumoku/core
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Supported Vendors
|
|
12
|
+
|
|
13
|
+
| Vendor | Icons | Description |
|
|
14
|
+
|--------|-------|-------------|
|
|
15
|
+
| Yamaha | 103 | Network equipment (RTX, SWX, WLX series) |
|
|
16
|
+
| Aruba | 55 | Wireless and switching |
|
|
17
|
+
| AWS | 477 | Cloud services icons |
|
|
18
|
+
| Juniper | 343 | Network equipment |
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { registerAllVendorIcons } from '@shumoku/icons'
|
|
24
|
+
|
|
25
|
+
// Register all vendor icons with @shumoku/core
|
|
26
|
+
registerAllVendorIcons()
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Then use vendor icons in your YAML:
|
|
30
|
+
|
|
31
|
+
```yaml
|
|
32
|
+
nodes:
|
|
33
|
+
- id: rt-01
|
|
34
|
+
label: "Router"
|
|
35
|
+
type: router
|
|
36
|
+
vendor: yamaha
|
|
37
|
+
model: rtx3510
|
|
38
|
+
|
|
39
|
+
- id: ap-01
|
|
40
|
+
label: "Access Point"
|
|
41
|
+
type: access-point
|
|
42
|
+
vendor: aruba
|
|
43
|
+
model: ap-505
|
|
44
|
+
|
|
45
|
+
- id: ec2-01
|
|
46
|
+
label: "Web Server"
|
|
47
|
+
vendor: aws
|
|
48
|
+
service: ec2
|
|
49
|
+
resource: instance
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Related Packages
|
|
53
|
+
|
|
54
|
+
- [`@shumoku/core`](https://www.npmjs.com/package/@shumoku/core) - Core library
|
|
55
|
+
- [`@shumoku/parser-yaml`](https://www.npmjs.com/package/@shumoku/parser-yaml) - YAML parser
|
|
56
|
+
|
|
57
|
+
## Documentation
|
|
58
|
+
|
|
59
|
+
- [Vendor Icons Reference](https://shumoku.packof.me/docs/vendor-icons) - Available icons
|
|
60
|
+
- [Playground](https://shumoku.packof.me/) - Interactive demo
|
|
61
|
+
|
|
62
|
+
## License
|
|
63
|
+
|
|
64
|
+
MIT
|