Skip to content

Commit 6945d07

Browse files
committed
Fix package metadata and README for v3.0.0 release
1 parent 3cc7c68 commit 6945d07

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,25 @@ Works in Node.js 18+ and in other runtimes that already provide `fetch`.
3434
## Installation
3535

3636
```bash
37-
npm install @ipgeolocation/ip-geolocation-js-sdk
37+
npm install ip-geolocation-api-javascript-sdk
3838
```
3939

4040
### ES Modules
4141

4242
```js
43-
import { IpGeolocationClient } from "@ipgeolocation/ip-geolocation-js-sdk";
43+
import { IpGeolocationClient } from "ip-geolocation-api-javascript-sdk";
4444
```
4545

4646
### CommonJS
4747

4848
```js
49-
const { IpGeolocationClient } = require("@ipgeolocation/ip-geolocation-js-sdk");
49+
const { IpGeolocationClient } = require("ip-geolocation-api-javascript-sdk");
5050
```
5151

5252
## Quick Start
5353

5454
```js
55-
import { IpGeolocationClient } from "@ipgeolocation/ip-geolocation-js-sdk";
55+
import { IpGeolocationClient } from "ip-geolocation-api-javascript-sdk";
5656

5757
async function main() {
5858
const client = new IpGeolocationClient({
@@ -85,7 +85,7 @@ You can pass plain objects to request methods. If you want validation before the
8585
8686
| Item | Value |
8787
|------|-------|
88-
| Package | `@ipgeolocation/ip-geolocation-js-sdk` |
88+
| Package | `ip-geolocation-api-javascript-sdk` |
8989
| API Type | IPGeolocation IP Location API |
9090
| Supported Endpoints | `/v3/ipgeo`, `/v3/ipgeo-bulk` |
9191
| Supported Inputs | IPv4, IPv6, domain |
@@ -223,7 +223,7 @@ You can also pass a custom `HttpTransport` as the second constructor argument.
223223
The examples below assume you already have a configured client and are running inside an async function or an ESM module with top-level `await`:
224224

225225
```js
226-
import { IpGeolocationClient } from "@ipgeolocation/ip-geolocation-js-sdk";
226+
import { IpGeolocationClient } from "ip-geolocation-api-javascript-sdk";
227227

228228
const client = new IpGeolocationClient({
229229
apiKey: process.env.IPGEO_API_KEY,
@@ -320,7 +320,7 @@ If you want request validation before sending the call, create the request expli
320320
import {
321321
IpGeolocationClient,
322322
LookupIpGeolocationRequest,
323-
} from "@ipgeolocation/ip-geolocation-js-sdk";
323+
} from "ip-geolocation-api-javascript-sdk";
324324

325325
const client = new IpGeolocationClient({
326326
apiKey: process.env.IPGEO_API_KEY,
@@ -361,7 +361,7 @@ Use raw methods when you want the original response body as a string.
361361
import {
362362
IpGeolocationClient,
363363
ResponseFormat,
364-
} from "@ipgeolocation/ip-geolocation-js-sdk";
364+
} from "ip-geolocation-api-javascript-sdk";
365365

366366
const client = new IpGeolocationClient({
367367
apiKey: process.env.IPGEO_API_KEY,
@@ -455,7 +455,7 @@ console.log(response.metadata.firstHeaderValue("x-ratelimit-remaining"));
455455
Use `toJson()` or `toPrettyJson()` when you want a stable JSON view of SDK objects.
456456
457457
```js
458-
import { toPrettyJson } from "@ipgeolocation/ip-geolocation-js-sdk";
458+
import { toPrettyJson } from "ip-geolocation-api-javascript-sdk";
459459

460460
const response = await client.lookupIpGeolocation({
461461
ip: "8.8.8.8",
@@ -501,7 +501,7 @@ import {
501501
IpGeolocationClient,
502502
RateLimitError,
503503
UnauthorizedError,
504-
} from "@ipgeolocation/ip-geolocation-js-sdk";
504+
} from "ip-geolocation-api-javascript-sdk";
505505

506506
const client = new IpGeolocationClient({
507507
apiKey: process.env.IPGEO_API_KEY,
@@ -585,12 +585,12 @@ No. Typed methods require JSON. Use raw methods if you need XML.
585585
586586
## Related Packages
587587
588-
- TypeScript runtime SDK: `@ipgeolocation/ip-geolocation-ts-sdk`
589-
- TypeScript types-only package: `@ipgeolocation/ip-geolocation-types`
588+
- TypeScript runtime SDK: `ip-geolocation-api-sdk-typescript`
589+
- TypeScript types-only package: `ip-geolocation-api-typescript-types`
590590
591591
## Links
592592
593-
- [npm package](https://www.npmjs.com/package/@ipgeolocation/ip-geolocation-js-sdk)
593+
- [npm package](https://www.npmjs.com/package/ip-geolocation-api-javascript-sdk)
594594
- [GitHub repository](https://github.com/IPGeolocation/ip-geolocation-api-javascript-sdk)
595595
- [API documentation](https://ipgeolocation.io/documentation/ip-location-api.html)
596596
- [Pricing](https://ipgeolocation.io/pricing.html)

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"author": "IPGeolocation.io",
3-
"name": "@ipgeolocation/ip-geolocation-js-sdk",
3+
"name": "ip-geolocation-api-javascript-sdk",
44
"version": "3.0.0",
55
"description": "Official JavaScript SDK for the IPGeolocation IP Location API with single and bulk lookup, typed JSON, and raw JSON/XML support.",
66
"license": "MIT",

0 commit comments

Comments
 (0)