@crawlora-org/youtube 0.1.2 → 0.1.4

package/README.md

@@ -1,7 +1,7 @@
 # @crawlora-org/youtube
 
 JavaScript and TypeScript client for Crawlora's hosted YouTube API.
-It calls Crawlora's service; it does not run a browser or scrape YouTube locally. A Crawlora account and `CRAWLORA_API_KEY` are required, and API use is billed under your Crawlora account. Crawlora is independent from and not endorsed by YouTube or its owners.
+It calls [Crawlora](https://crawlora.net); it does not run a browser or scrape YouTube locally. A Crawlora account and `CRAWLORA_API_KEY` are required, and API use is billed under your Crawlora account. Crawlora is independent from and not endorsed by YouTube or its owners.
 
 ## Install
 
@@ -9,14 +9,31 @@ It calls Crawlora's service; it does not run a browser or scrape YouTube locally
 npm install @crawlora-org/youtube
 ```
 
+## Get an API key
+
+Create an account at [crawlora.net](https://crawlora.net/signup), then open the [Crawlora console](https://crawlora.net/app) for API-key setup. Set your key in the shell before running the client:
+
+```sh
+export CRAWLORA_API_KEY="your-crawlora-api-key"
+```
+
 ## Use
 
+Save this example as `example.mjs`, then run `node example.mjs` after installing the package and setting your API key.
+
 ```js
+import process from "node:process";
 import { YouTubeClient } from "@crawlora-org/youtube";
 
-const client = new YouTubeClient({ apiKey: process.env.CRAWLORA_API_KEY });
-const result = await client.search({ q: "science explainers", type: "video" });
-console.log(result);
+const apiKey = process.env.CRAWLORA_API_KEY;
+if (!apiKey) throw new Error("Set CRAWLORA_API_KEY before running this example.");
+const client = new YouTubeClient({ apiKey });
+const result1 = await client.search({ q: "science explainers", type: "video" });
+console.log(result1);
+const result2 = await client.video({ id: "dQw4w9WgXcQ" });
+console.log(result2);
+const result3 = await client.transcript({ id: "dQw4w9WgXcQ", format: "text" });
+console.log(result3);
 ```
 
 The client also exports `Client` as an alias for `YouTubeClient`. Operation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crawlora-org/youtube",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Typed JavaScript client for the Crawlora YouTube API",
   "homepage": "https://github.com/Crawlora-org/crawlora-youtube#readme",
   "bugs": { "url": "https://github.com/Crawlora-org/crawlora-youtube/issues" },

package/src/index.js

@@ -9,7 +9,7 @@ import {
 
 export class YouTubeClient extends CrawloraClient {
   constructor(options = {}) {
-    super({ ...options, userAgent: options.userAgent ?? "crawlora-youtube-js/0.1.2" });
+    super({ ...options, userAgent: options.userAgent ?? "crawlora-youtube-js/0.1.4" });
     this["captions"] = (...args) => this.request("youtube-captions", ...args);
     this["channelPlaylists"] = (...args) => this.request("youtube-channel-playlists", ...args);
     this["channelSearch"] = (...args) => this.request("youtube-channel-search", ...args);
@@ -36,5 +36,5 @@ export {
   CrawloraServerError
 };
 export { groups, operations, operationCount, OperationIds } from "./operations.js";
-export const VERSION = "0.1.2";
+export const VERSION = "0.1.4";
 export default YouTubeClient;