Cosmetic updates

Author: RantsRoamer

README.md

@@ -585,6 +585,10 @@ List all crawl jobs.
 
 Health check endpoint.
 
+### `GET /about`
+
+Credits and repository info. Returns: `{ name, version, by, repository }` (e.g. by: John F. Gonzales, repository: https://github.com/RantsRoamer/OpenScrape).
+
 ## Development
 
 ### Prerequisites

package.json

@@ -1,6 +1,6 @@
 {
   "name": "openscrape",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Open-source web scraping library with headless browser support, pagination, and data extraction",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/about.ts

@@ -0,0 +1,17 @@
+/**
+ * About / credits for OpenScrape (CLI and API)
+ */
+
+export const ABOUT = {
+  by: 'John F. Gonzales',
+  repository: 'https://github.com/RantsRoamer/OpenScrape',
+} as const;
+
+export function getAboutInfo(version: string) {
+  return {
+    name: 'openscrape',
+    version,
+    by: ABOUT.by,
+    repository: ABOUT.repository,
+  };
+}

src/api.ts

@@ -2,12 +2,19 @@
  * REST API server for OpenScrape
  */
 
+import { readFileSync } from 'fs';
 import express, { Request, Response, NextFunction } from 'express';
 import { createServer } from 'http';
+import * as path from 'path';
 import { OpenScrape } from './scraper';
 import { ScrapeOptions, CrawlJob } from './types';
 import { randomUUID } from 'crypto';
 import { attachWebSocketServer, broadcastJobEvent, closeWebSocketServer } from './websocket';
+import { getAboutInfo } from './about';
+
+const pkg = JSON.parse(
+  readFileSync(path.join(__dirname, '..', 'package.json'), 'utf-8')
+) as { version: string };
 
 const app = express();
 app.use(express.json());
@@ -99,6 +106,13 @@ app.get('/health', (req: Request, res: Response) => {
   res.json({ status: 'ok', timestamp: new Date().toISOString() });
 });
 
+/**
+ * GET /about - Credits and repository
+ */
+app.get('/about', (req: Request, res: Response) => {
+  res.json(getAboutInfo(pkg.version ?? '1.0.0'));
+});
+
 /**
  * Process crawl job
  */

src/cli.ts

@@ -4,19 +4,26 @@
  * Command-line interface for OpenScrape
  */
 
+import { readFileSync } from 'fs';
 import { Command } from 'commander';
 import * as fs from 'fs/promises';
 import * as path from 'path';
 import { OpenScrape } from './scraper';
 import { ScrapeOptions } from './types';
 import { toHtml, toText, toCsv, toYaml } from './formatters';
+import { ABOUT, getAboutInfo } from './about';
+
+const packageJson = JSON.parse(
+  readFileSync(path.join(__dirname, '..', 'package.json'), 'utf-8')
+) as { version: string };
+const version = packageJson.version ?? '1.0.0';
 
 const program = new Command();
 
 program
   .name('openscrape')
-  .description('Open-source web scraping library')
-  .version('1.0.0');
+  .description('Open-source web scraping library. By: ' + ABOUT.by + ' | ' + ABOUT.repository)
+  .version(version);
 
 program
   .command('crawl')
@@ -200,6 +207,16 @@ program
     }
   });
 
+program
+  .command('about')
+  .description('Show credits and repository')
+  .action(() => {
+    const info = getAboutInfo(version);
+    console.log(`${info.name} v${info.version}`);
+    console.log(`By: ${info.by}`);
+    console.log(info.repository);
+  });
+
 program
   .command('serve')
   .description('Start the REST API server')