Skip to content

Commit

Permalink
[ts-api] Update readme and example (#356)
Browse files Browse the repository at this point in the history
## Summary

* Published dev package
* Updated readme
* Updated example to use published version
 
# How was it tested?

`node index.js` in example dir.

---------

Signed-off-by: Mike Landau <mikeland86@gmail.com>
Co-authored-by: Greg Curtis <greg.curtis@jetpack.io>
  • Loading branch information
mikeland73 and gcurtis authored Jul 24, 2024
1 parent 3eac418 commit a566560
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 4 deletions.
2 changes: 2 additions & 0 deletions api/ts/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Jetify API TypeScript Client

**Warning:** this client is currently in development and subject to change.

## Usage

```bash
Expand Down
7 changes: 6 additions & 1 deletion api/ts/devbox.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,12 @@
"scripts": {
"build": "pnpm run build",
"lint": "pnpm run lint",
"fmt": "pnpm run fmt"
"fmt": "pnpm run fmt",
"typecheck": "pnpm run typecheck",
// Run all checks before publishing the package
"check": "devbox run typecheck && devbox run lint && devbox run fmt",
// Publish the package to the npm registry. Access token is required.
"publish": "devbox run check && pnpm publish --access public $@",
}
}
}
2 changes: 1 addition & 1 deletion api/ts/examples/create-sandbox/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,6 @@
"@bufbuild/protobuf": "^1.10.0",
"@connectrpc/connect": "^1.4.0",
"@connectrpc/connect-web": "^1.4.0",
"@jetify/client": "link:../../dist"
"@jetify/client": "0.1.0-dev"
}
}
13 changes: 11 additions & 2 deletions api/ts/examples/create-sandbox/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a566560

Please sign in to comment.