@dheerajsom/pinhub 0.1.0 → 0.1.2

package/README.md

@@ -1,6 +1,6 @@
 # pinhub — pinout diagrams in your terminal
 
-`pinhub` installs a tiny cross-platform command, **`ph`**, that draws hardware
+`@dheerajsom/pinhub` installs a tiny cross-platform command, **`ph`**, that draws hardware
 board pinout diagrams straight in your terminal — pin numbers, GPIO names,
 power/ground rails, and the safety warnings that matter, sourced from official
 vendor documentation.
@@ -31,7 +31,7 @@ Linux. No network access, no telemetry — all board data ships in the package.
 Requires Node.js 18.18 or newer.
 
 ```bash
-npm install -g pinhub
+npm install -g @dheerajsom/pinhub
 ph rpi5
 ```
 
@@ -79,13 +79,19 @@ ph rpi5 --source
 
 ## Boards
 
+The catalog carries the full [PinHub website](https://pinhub.vercel.app) board
+set — 125 boards across Raspberry Pi, Arduino, Espressif, STM32, Teensy,
+Adafruit, SparkFun, Seeed, BeagleBone, Jetson, and more. Run `ph list` to see
+everything. A few starters:
+
 | Board | Try |
 | --- | --- |
-| Raspberry Pi 5 (40-pin GPIO header) | `ph rpi5` |
-| Raspberry Pi Pico | `ph pico` |
-| Raspberry Pi Pico W | `ph pico-w` |
-| Arduino UNO R3 | `ph uno` |
-| ESP32 DevKit V1 (DOIT, 30-pin) | `ph esp32` |
+| Raspberry Pi 5 / 4 / Zero 2 W | `ph rpi5` · `ph rpi4` · `ph zero-2-w` |
+| Raspberry Pi Pico / Pico 2 / W | `ph pico` · `ph pico2` · `ph pico-w` |
+| Arduino UNO R3 / Nano / Mega | `ph uno` · `ph nano` · `ph mega` |
+| ESP32 DevKit V1, S2/S3/C3/C6/H2 | `ph esp32` · `ph esp32-s3` · `ph esp32-c3` |
+| STM32 Blue Pill / Nucleo | `ph blue-pill` · `ph nucleo` |
+| Teensy 4.1, micro:bit V2, … | `ph teensy` · `ph microbit` |
 
 ## Color and accessibility
 
@@ -114,20 +120,27 @@ risk.
 
 ## Contributing boards
 
-Board data lives in `src/boards/`, one module per board, using the typed model
-in `src/model.ts`. To add a board:
-
-1. Create `src/boards/<board-id>.ts` exporting a `Board` object.
-   - Every pin needs a `physical` number, a grid `position`, a `label`, and a
-     `category`.
-   - Include at least one **official** source URL (datasheet, schematic, or
-     vendor pinout). Third-party sources are allowed only when official
-     documentation is unavailable and must be marked `official: false`.
-   - Include the safety warnings that apply (logic level, strapping pins,
-     reserved pins, revision differences).
-2. Register it in `src/boards/index.ts` and add aliases people actually type.
+Most of the catalog is **generated from the PinHub website data**
+(`src/lib/boards.ts` at the repository root). To add or fix a board:
+
+1. Add it to the website catalog first (it must stay source-backed there),
+   then run `npm run generate:boards` in `cli/` to regenerate
+   `src/boards/generated.ts`.
+2. Add short aliases people actually type in `scripts/curated-aliases.ts`.
 3. Run `npm test` — catalog invariant tests check sources, warnings, alias
-   uniqueness, and pin-grid consistency.
+   uniqueness, and pin-grid consistency across all 125 boards.
+
+Five flagship boards (Pi 5, Pico, Pico W, UNO R3, ESP32 DevKit V1) have richer
+hand-written modules in `src/boards/`, one file per board, using the typed
+model in `src/model.ts`. For those:
+
+- Every pin needs a `physical` number, a grid `position`, a `label`, and a
+  `category`.
+- Include at least one **official** source URL (datasheet, schematic, or
+  vendor pinout). Third-party sources are allowed only when official
+  documentation is unavailable and must be marked `official: false`.
+- Include the safety warnings that apply (logic level, strapping pins,
+  reserved pins, revision differences).
 
 ## Development
 

package/SETUP.md

@@ -30,7 +30,7 @@ network — all board data is bundled.
 ## 2. Install from npm (recommended)
 
 ```bash
-npm install -g pinhub
+npm install -g @dheerajsom/pinhub
 ```
 
 Then verify:
@@ -70,11 +70,14 @@ npm run dev -- rpi5
 ## 4. First steps
 
 ```bash
-ph list                 # see every board in the catalog
+ph list                 # see all 125 boards in the catalog
 ph rpi5                 # Raspberry Pi 5 GPIO header
 ph pico                 # Raspberry Pi Pico
 ph uno                  # Arduino UNO R3
 ph esp32                # ESP32 DevKit V1 (DOIT, 30-pin)
+ph esp32-s3             # ESP32-S3-DevKitC-1
+ph blue-pill            # STM32F103 "Blue Pill"
+ph teensy               # Teensy 4.1
 ph search raspberry     # find boards
 ph info esp32           # warnings, sources, aliases
 ph rpi5 --source        # official documentation links
@@ -114,7 +117,7 @@ control it: widen the terminal, or use `--compact`, or `--width 100`.
 **Uninstall**
 
 ```bash
-npm uninstall -g pinhub
+npm uninstall -g @dheerajsom/pinhub
 ```
 
 ## 6. A note on hardware safety

package/dist/boards/generated.d.ts

@@ -0,0 +1,2 @@
+import type { Board } from "../model.js";
+export declare const generatedBoards: Board[];