From 000bedd5fdbdec7767cfdc79e062a896ef33ecac Mon Sep 17 00:00:00 2001
From: Matthew Thomas <matthewthomasgb@gmail.com>
Date: Sun, 20 Jul 2025 19:40:42 +0100
Subject: [PATCH] chore: rename package to ctrf-cli

---
 CHANGELOG.md                 |  0
 README.md                    | 28 ++++++----------------------
 package-lock.json            |  8 ++++----
 package.json                 | 11 ++++-------
 src/methods/merge-reports.ts |  1 +
 src/methods/read-reports.ts  |  1 +
 6 files changed, 16 insertions(+), 33 deletions(-)
 create mode 100644 CHANGELOG.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..e69de29
diff --git a/README.md b/README.md
index 9e611d2..a3ea9a3 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # CTRF CLI
 
-Various CTRF utilities available programatically and by command line
+Various CTRF utilities available from the command line
 
 <div align="center">
 <div style="padding: 1.5rem; border-radius: 8px; margin: 1rem 0; border: 1px solid #30363d;">
@@ -39,7 +39,7 @@ This might be useful if you need a single report, but your chosen reporter gener
 To merge CTRF reports in a specified directory, use the following command:
 
 ```sh
-npx ctrf merge <directory>
+npx ctrf-cli merge <directory>
 ```
 
 Replace `directory` with the path to the directory containing the CTRF reports you want to merge.
@@ -49,19 +49,19 @@ Replace `directory` with the path to the directory containing the CTRF reports y
 -o, --output `filename`: Output file name for the merged report. Default is ctrf-report.json.
 
 ```sh
-npx ctrf merge <directory> --output my-merged-report.json
+npx ctrf-cli merge <directory> --output my-merged-report.json
 ```
 
 -d, --output-dir `directory`: Output directory for the merged report. Default is the same directory as the input reports.
 
 ```sh
-npx ctrf merge <directory> --output-dir /path/to/output
+npx ctrf-cli merge <directory> --output-dir /path/to/output
 ```
 
 -k, --keep-reports: Keep existing reports after merging. By default, the original reports will be deleted after merging.
 
 ```sh
-npx ctrf merge <directory> --keep-reports
+npx ctrf-cli merge <directory> --keep-reports
 ```
 
 ## Flaky
@@ -72,7 +72,7 @@ Usage
 To output flaky tests, use the following command:
 
 ```sh
-npx ctrf flaky <file-path>
+npx ctrf-cli flaky <file-path>
 ```
 
 Replace <file-path> with the path to the CTRF report file you want to analyze.
@@ -87,22 +87,6 @@ Found 1 flaky test(s) in reports/sample-report.json:
 - Test Name: Test 1, Retries: 2
 ```
 
-## Programmatic Methods
-
-```sh
-npm install ctrf
-```
-
-The following programmatic methods are available:
-
-`mergeReports` - This method merges multiple CTRF reports into a single report.
-
-`readSingleReport` - Reads and parses a single CTRF report file from a specified file path.
-
-`readReportsFromDirectory` - Reads all CTRF report files from a given directory.
-
-`readReportsFromGlobPattern` - Reads all CTRF report files from a given glob pattern.
-
 ## What is CTRF?
 
 CTRF is a universal JSON test report schema that addresses the lack of a standardized format for JSON test reports.
diff --git a/package-lock.json b/package-lock.json
index 084e166..a10fc23 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
-  "name": "ctrf",
-  "version": "0.0.12",
+  "name": "ctrf-cli",
+  "version": "0.0.1",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
-      "name": "ctrf",
-      "version": "0.0.12",
+      "name": "ctrf-cli",
+      "version": "0.0.1",
       "license": "MIT",
       "dependencies": {
         "glob": "^11.0.1",
diff --git a/package.json b/package.json
index 07bdb0f..ef289e3 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
-  "name": "ctrf",
-  "version": "0.0.12",
-  "description": "",
+  "name": "ctrf-cli",
+  "version": "0.0.1",
+  "description": "Various CTRF utilities available from the command line",
   "main": "dist/index.js",
   "bin": {
     "ctrf": "dist/cli.js"
@@ -13,10 +13,7 @@
     "dist/",
     "README.md"
   ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ctrf-io/ctrf-cli"
-  },
+  "repository": "github:ctrf-io/ctrf-cli",
   "homepage": "https://ctrf.io",
   "author": "Matthew Thomas",
   "license": "MIT",
diff --git a/src/methods/merge-reports.ts b/src/methods/merge-reports.ts
index 1ddbc96..dcb7fc4 100644
--- a/src/methods/merge-reports.ts
+++ b/src/methods/merge-reports.ts
@@ -1,3 +1,4 @@
+// TO BE REMOVED, WILL USE THE CTRF LIBRARY INSTEAD
 import { CtrfReport, Summary } from "../../types/ctrf";
 
 /**
diff --git a/src/methods/read-reports.ts b/src/methods/read-reports.ts
index 9f03836..41e75fe 100644
--- a/src/methods/read-reports.ts
+++ b/src/methods/read-reports.ts
@@ -1,3 +1,4 @@
+// TO BE REMOVED, WILL USE THE CTRF LIBRARY INSTEAD
 import fs from 'fs';
 import path from 'path';
 import { CtrfReport } from '../../types/ctrf';