Skip to content

Commit 55fe707

Browse files
committed
Document TypeScript package publishing
1 parent 56aa5ad commit 55fe707

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,11 @@ The smoke tests (`make smoke`) automatically verify that signed `GET`/`HEAD` req
116116

117117
To allow users to download files, your backend application must generate an **edge signed URL**. These use a standard HMAC signature. Since the gateway verifies the signature before generating a ticket, bogus requests are dropped at the edge—saving your private network from dealing with malicious traffic.
118118

119-
We provide drop-in packages for Go, TypeScript, and Python under the `packages/` directory.
119+
We provide drop-in packages for Go, TypeScript, and Python under the `packages/` directory. The TypeScript package is published to GitHub Packages as `@terion-name/air3-edgesign`:
120+
121+
```sh
122+
npm install @terion-name/air3-edgesign --registry=https://npm.pkg.github.com
123+
```
120124

121125
### Go Example
122126

@@ -135,7 +139,7 @@ raw, err := edgesign.SignURL(edgesign.SignInput{
135139
### TypeScript Example
136140

137141
```ts
138-
import { signUrl, verifyUrl } from './packages/ts/src/index.ts';
142+
import { signUrl, verifyUrl } from '@terion-name/air3-edgesign';
139143

140144
const raw = signUrl({
141145
method: 'GET',
@@ -178,14 +182,14 @@ make validate # format, test, build, and check compose config
178182
make fmt # format Go code
179183
make test # run Go tests
180184
make build # build binaries into ./bin
181-
make ts-test # run TypeScript package tests
185+
make ts-test # install, test, and build the TypeScript package
182186
make python-test # run Python package tests
183187
go test ./... -race # run race-enabled Go tests
184188
```
185189

186190
## Releases & Docker Images
187191

188-
We publish multi-architecture Docker images (Linux on `amd64` and `arm64`) to the GitHub Container Registry on every release. Cross-compiled binaries for macOS, Windows, and Linux are also attached to GitHub releases.
192+
We publish multi-architecture Docker images (Linux on `amd64` and `arm64`) to the GitHub Container Registry on every release. Cross-compiled binaries for macOS, Windows, and Linux are also attached to GitHub releases. The same tag workflow publishes `@terion-name/air3-edgesign` to GitHub Packages with the tag as the npm version.
189193

190194
- `ghcr.io/terion-name/air3/edge-gateway:<tag>`
191195
- `ghcr.io/terion-name/air3/private-connector:<tag>`

0 commit comments

Comments
 (0)