Updating documentation

docs/Churn-Finding-Hotspots.md

@@ -10,17 +10,19 @@ bin/phpcca churn <path-to-folder> [--config=<file>] [--git=<vcs>] [--debug]
 
 - `<path-to-folder>`: **Required.** Path to the PHP file or directory to analyze.
 - `--config, -c`: Path to a configuration file (optional).
-- `--git, -s`: Version control system to use for change detection (default: `git`).
+- `--vcs, -s`: Version control system to use for change detection (default: `git`).
 - `--debug`: Enables debug output.
 
 ## What it does
 
 1. **Collects cognitive metrics** for each class in the given path.
 2. **Counts how many times each file/class has changed** using your VCS (default: Git).
-3. **Calculates a churn score**:  
+3. **Calculates a churn score**:
    `churn = timesChanged * score`
 4. **Ranks classes by churn score** so you can focus on the most critical hotspots.
 
+⚠️ **For the time being only Git is supported as the VCS backend!** ⚠️
+
 ## Example Output
 
 ```
@@ -43,4 +45,3 @@ bin/phpcca churn <path-to-folder> [--config=<file>] [--git=<vcs>] [--debug]
 - Only classes with a valid class name are included in the results.
 - The command supports extensible VCS backends (default is Git).
   - For now only Git is supported.
-

readme.md

@@ -6,6 +6,12 @@ Cognitive Code Analysis is an approach to understanding and improving code by fo
 
 [Source: Human Cognitive Limitations. Broad, Consistent, Clinical Application of Physiological Principles Will Require Decision Support](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC5822395/)
 
+## Installation
+
+```bash
+composer require --dev phauthentic/cognitive-code-analysis
+```
+
 ## Running it
 
 Cognitive Complexity Analysis
@@ -28,7 +34,9 @@ bin/phpcca analyse <path-to-folder> --baseline cognitive.json
 
 ### Finding Hotspots
 
-Churn is a measure of how much code has changed over time. It helps to find the most changed and complex areas in your codebase, which are often the most error-prone and difficult to maintain.
+Churn is a measure of how much code has changed over time. It helps to find the most changed and complex areas in your codebase, which are often the most error-prone and difficult to maintain. Read the [Churn - Finding Hotspots](./docs/Churn-Finding-Hotspots.md) documentation for more details.
+
+Note that this requires a version control system (VCS) to be set up, such as Git.
 
 ```bash
 bin/phpcca churn <path-to-folder>

src/Command/ChurnCommand.php

@@ -25,7 +25,7 @@ class ChurnCommand extends Command
 
     public const OPTION_CONFIG_FILE = 'config';
 
-    public const OPTION_VCS = 'git';
+    public const OPTION_VCS = 'vcs';
 
     public const OPTION_DEBUG = 'debug';