@openwaters/noaa-current-stations 0.4.0 → 0.5.0

package/README.md

@@ -16,6 +16,27 @@ schema — so you don't have to talk to the API at all.
 npm install @openwaters/noaa-current-stations
 ```
 
+## Use the bundle
+
+The extracted station bundle ships with the package, so the common case needs no
+network and no CLI run:
+
+```js
+import bundle from "@openwaters/noaa-current-stations/currents.json" with { type: "json" };
+
+// { note, generated, crossFlow, stations } — the records are under `stations`,
+// and their ids are bare NOAA keys, unprefixed.
+const deception = bundle.stations.find((s) => s.id === "PUG1701");
+```
+
+That path is a supported entry point and will not move without a major version.
+It adds about 260 KB to the download and 3.2 MB unpacked — JSON compresses well,
+so the wire cost is far smaller than the file. Consumers that only want the
+extractor or the schema can ignore it; nothing imports it implicitly.
+
+Regenerate it yourself with `npx noaa-current-stations extract currents.json` if
+you need fresher data than the last release.
+
 ## Use it as a CLI
 
 ```bash
@@ -117,8 +138,8 @@ as a diff. [`update-stations`](.github/workflows/update-stations.yml) keeps it c
 | Monthly | forced full extraction (~2,800 paced requests, ~25 min) | NOAA revising an existing station's constituents in place |
 
 The weekly pre-flight only escalates to a full extraction when something moved, so the
-common case costs a single request. Either way, a change opens a **pull request** with
-the validation summary — nothing updates silently.
+common case costs a single request. Either way, a change pushes a branch and files a
+review issue with the validation summary and pull-request link — nothing updates silently.
 
 `stations.lock.json` pins the current list; `noaa-current-stations check` is the same
 pre-flight you can run yourself, and exits non-zero on drift.
@@ -128,7 +149,7 @@ npx noaa-current-stations check                    # has NOAA's list moved?
 npx noaa-current-stations validate currents.json   # structural check on a bundle
 ```
 
-`validate` is what gates the automated PR: it fails on a subordinate whose reference
+`validate` gates the automated review branch: it fails on a subordinate whose reference
 went missing, duplicate ids, a harmonic station with no constituents, or a bundle that
 lost its Z₀ offsets — the shapes a truncated extraction takes.