@crawlora-org/flashscore 0.1.1 → 0.1.3

package/README.md

@@ -1,7 +1,7 @@
 # @crawlora-org/flashscore
 
 JavaScript and TypeScript client for Crawlora's hosted Flashscore API.
-It calls Crawlora's service; it does not run a browser or scrape Flashscore 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 Flashscore or its owners.
+It calls [Crawlora](https://crawlora.net); it does not run a browser or scrape Flashscore 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 Flashscore or its owners.
 
 ## Install
 
@@ -9,14 +9,29 @@ It calls Crawlora's service; it does not run a browser or scrape Flashscore loca
 npm install @crawlora-org/flashscore
 ```
 
+## 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 { FlashscoreClient } from "@crawlora-org/flashscore";
 
-const client = new FlashscoreClient({ apiKey: process.env.CRAWLORA_API_KEY });
-const result = await client.sports({  });
-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 FlashscoreClient({ apiKey });
+const result1 = await client.sports({});
+console.log(result1);
+const result2 = await client.scores({ sport: "football", day_offset: 0 });
+console.log(result2);
 ```
 
 The client also exports `Client` as an alias for `FlashscoreClient`. Operation

package/package.json

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

package/src/index.js

@@ -9,7 +9,7 @@ import {
 
 export class FlashscoreClient extends CrawloraClient {
   constructor(options = {}) {
-    super({ ...options, userAgent: options.userAgent ?? "crawlora-flashscore-js/0.1.1" });
+    super({ ...options, userAgent: options.userAgent ?? "crawlora-flashscore-js/0.1.3" });
     this["calendar"] = (...args) => this.request("flashscore-calendar", ...args);
     this["calendarCategories"] = (...args) => this.request("flashscore-calendar-categories", ...args);
     this["competitions"] = (...args) => this.request("flashscore-competitions", ...args);
@@ -46,5 +46,5 @@ export {
   CrawloraServerError
 };
 export { groups, operations, operationCount, OperationIds } from "./operations.js";
-export const VERSION = "0.1.1";
+export const VERSION = "0.1.3";
 export default FlashscoreClient;