Skip to content

ZIP-0: renames npm package to use the ziptax org #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ericlakich merged 1 commit into from
Jan 28, 2026
Merged

ZIP-0: renames npm package to use the ziptax org #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 1 addition & 15 deletions .github/workflows/publish.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,4 @@ jobs:
- name: Publish to npm
run: npm publish --provenance --access public
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

- name: Create release announcement
uses: actions/github-script@v7
with:
script: |
const release = context.payload.release;
if (release) {
github.rest.repos.createCommitComment({
owner: context.repo.owner,
repo: context.repo.repo,
commit_sha: context.sha,
body: `🎉 Published version ${release.tag_name} to npm!`
});
}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Official Node.js SDK for the [ZipTax API](https://www.zip-tax.com/) - Get accurate sales and use tax rates for any US address.

[![npm version](https://badge.fury.io/js/ziptax.svg)](https://www.npmjs.com/package/ziptax)
[![npm version](https://badge.fury.io/js/%40ziptax%2Fnode-sdk.svg)](https://www.npmjs.com/package/@ziptax/node-sdk)
[![Test](https://github.com/ziptax/ziptax-node/actions/workflows/test.yml/badge.svg)](https://github.com/ziptax/ziptax-node/actions/workflows/test.yml)
[![codecov](https://codecov.io/gh/ziptax/ziptax-node/branch/main/graph/badge.svg)](https://codecov.io/gh/ziptax/ziptax-node)

Expand All @@ -20,13 +20,13 @@ Official Node.js SDK for the [ZipTax API](https://www.zip-tax.com/) - Get accura
## Installation

```bash
npm install ziptax
npm install @ziptax/node-sdk
```

## Quick Start

```typescript
import { ZiptaxClient } from 'ziptax';
import { ZiptaxClient } from '@ziptax/node-sdk';

// Initialize the client with your API key
const client = new ZiptaxClient({
Expand Down Expand Up @@ -144,7 +144,7 @@ import {
ZiptaxValidationError,
ZiptaxNetworkError,
ZiptaxRateLimitError,
} from 'ziptax';
} from '@ziptax/node-sdk';

try {
const result = await client.getSalesTaxByAddress({
Expand Down Expand Up @@ -288,7 +288,7 @@ MIT License - see [LICENSE](./LICENSE) file for details.

## Links

- [npm package](https://www.npmjs.com/package/ziptax)
- [npm package](https://www.npmjs.com/package/@ziptax/node-sdk)
- [GitHub repository](https://github.com/ziptax/ziptax-node)
- [ZipTax API Documentation](https://www.zip-tax.com/documentation)
- [Changelog](./CHANGELOG.md)
4 changes: 2 additions & 2 deletions docs/spec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Project Metadata
# -----------------------------------------------------------------------------
project:
name: "ziptax-node"
name: "@ziptax/node-sdk"
language: "typescript"
version: "1.0.0"
description: "Official Node.js SDK for the ZipTax API"
Expand Down Expand Up @@ -55,7 +55,7 @@ api:
# -----------------------------------------------------------------------------
sdk:
# Package/module naming
package_name: "ziptax"
package_name: "@ziptax/node-sdk"
namespace: "Ziptax"

# SDK structure approach
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@ziptax/node-sdk",
"version": "0.1.2-beta",
"version": "0.1.4-beta",
"description": "Official Node.js SDK for the ZipTax API",
"main": "dist/cjs/index.js",
"module": "dist/esm/index.js",
Expand Down
Loading