x-twitter-scraper 0.3.0 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.3.1 (2026-05-05)
+
+Full Changelog: [v0.3.0...v0.3.1](https://github.com/Xquik-dev/x-twitter-scraper-typescript/compare/v0.3.0...v0.3.1)
+
+### Chores
+
+* improve npm package discoverability metadata
+
 ## 0.3.0 (2026-04-25)
 
 Full Changelog: [v0.2.1...v0.3.0](https://github.com/Xquik-dev/x-twitter-scraper-typescript/compare/v0.2.1...v0.3.0)

package/README.md

@@ -1,13 +1,61 @@
-# X Twitter Scraper TypeScript API Library
+# Xquik TypeScript SDK for X (Twitter) Scraper API
 
 [![NPM version](<https://img.shields.io/npm/v/x-twitter-scraper.svg?label=npm%20(stable)>)](https://npmjs.org/package/x-twitter-scraper) ![npm bundle size](https://img.shields.io/bundlephobia/minzip/x-twitter-scraper)
 
-This library provides convenient access to the X Twitter Scraper REST API from server-side TypeScript or JavaScript.
+Xquik TypeScript SDK for the X (Twitter) Scraper API: typed REST, HMAC webhooks, MCP, and docs at https://docs.xquik.com/api-reference/overview.
 
-The REST API documentation can be found on [xquik.com](https://xquik.com). The full API of this library can be found in [api.md](api.md).
+Use it to search tweets, look up users, monitor accounts, run giveaway draws, and connect AI agents to X data without maintaining scraping infrastructure.
+
+[SDK API](api.md) | [REST API Docs](https://docs.xquik.com/api-reference/overview) | [OpenAPI Spec](https://xquik.com/openapi.json) | [Webhooks](https://docs.xquik.com/api-reference/webhooks/create) | [MCP Server](https://xquik.com/mcp) | [Python SDK](https://github.com/Xquik-dev/x-twitter-scraper-python)
 
 It is generated with [Stainless](https://www.stainless.com/).
 
+## Tweet Search & User Lookup
+
+Build TypeScript services that search tweets, fetch user profiles, check follower relationships, download media, and inspect timeline data through one typed REST client.
+
+## Real-Time Monitoring & Webhooks
+
+Create monitors for X accounts, receive HMAC-signed webhook events, and query event history from the same SDK surface.
+
+## AI Agent Workflows With MCP
+
+Connect agent systems to Xquik through the MCP server while keeping custom product code on the typed REST SDK.
+
+## Giveaway Draws & Extractions
+
+Run giveaway draws, export winners, and launch extraction jobs for replies, reposts, quotes, followers, lists, communities, threads, articles, and tweet search.
+
+## Xquik SDK vs Building From Scratch
+
+| Need | Xquik TypeScript SDK | Building From Scratch |
+| --- | --- | --- |
+| Typed REST calls | Generated request and response types | Hand-maintained schemas |
+| Real-time events | Monitors plus HMAC webhooks | Separate queue and signing work |
+| AI agent access | REST SDK plus MCP server | Custom bridge layer |
+| X data workflows | Search, user lookup, draws, exports, and monitoring | Many separate integrations |
+
+## Package & Registry Trust
+
+- Package: [npm `x-twitter-scraper`](https://www.npmjs.com/package/x-twitter-scraper)
+- Source: [Xquik-dev/x-twitter-scraper-typescript](https://github.com/Xquik-dev/x-twitter-scraper-typescript)
+- License: Apache-2.0
+- Citation metadata: [CITATION.cff](CITATION.cff)
+
+## FAQ
+
+### Is this SDK only for browser apps?
+
+No. It is designed for server-side TypeScript and JavaScript runtimes.
+
+### Where are the REST endpoints documented?
+
+Start with the [REST API overview](https://docs.xquik.com/api-reference/overview), then use [api.md](api.md) for generated method names.
+
+### Can this work with AI agents?
+
+Yes. Use the SDK in your app code and the [MCP server](https://xquik.com/mcp) for MCP-compatible agent clients.
+
 ## Installation
 
 ```sh

package/package.json

@@ -1,13 +1,29 @@
 {
   "name": "x-twitter-scraper",
-  "version": "0.3.0",
-  "description": "The official TypeScript library for the X Twitter Scraper API",
+  "version": "0.3.1",
+  "description": "Official TypeScript SDK for the Xquik X (Twitter) Scraper API, webhooks, monitoring, and agent workflows",
   "author": "X Twitter Scraper <support@xquik.com>",
   "types": "./index.d.ts",
   "main": "./index.js",
   "type": "commonjs",
+  "homepage": "https://docs.xquik.com/sdks/typescript",
   "repository": "github:Xquik-dev/x-twitter-scraper-typescript",
+  "keywords": [
+    "x-api",
+    "twitter-api",
+    "twitter-scraper",
+    "x-twitter-scraper",
+    "xquik",
+    "typescript-sdk",
+    "nodejs",
+    "api-client",
+    "webhooks",
+    "monitoring",
+    "mcp",
+    "social-media-api"
+  ],
   "license": "Apache-2.0",
+  "packageManager": "pnpm@10.30.1",
   "files": [
     "**/*"
   ],
@@ -15,10 +31,23 @@
   "publishConfig": {
     "access": "public"
   },
+  "scripts": {
+    "test": "./scripts/test",
+    "build": "./scripts/build",
+    "format": "./scripts/format",
+    "tsn": "ts-node -r tsconfig-paths/register",
+    "lint": "./scripts/lint",
+    "fix": "./scripts/format"
+  },
   "dependencies": {},
   "overrides": {
     "minimatch": "^9.0.5"
   },
+  "pnpm": {
+    "overrides": {
+      "minimatch": "^9.0.5"
+    }
+  },
   "resolutions": {
     "minimatch": "^9.0.5"
   },
@@ -131,13 +160,5 @@
     "./version.mjs": {
       "default": "./version.mjs"
     }
-  },
-  "scripts": {
-    "test": "./scripts/test",
-    "build": "./scripts/build",
-    "format": "./scripts/format",
-    "tsn": "ts-node -r tsconfig-paths/register",
-    "lint": "./scripts/lint",
-    "fix": "./scripts/format"
   }
 }

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.3.1'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.3.1";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "0.3.0";
+export declare const VERSION = "0.3.1";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '0.3.0'; // x-release-please-version
+exports.VERSION = '0.3.1'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '0.3.0'; // x-release-please-version
+export const VERSION = '0.3.1'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map