diff --git a/diff-check/README.md b/diff-check/README.md index d3d96d3..519a39d 100644 --- a/diff-check/README.md +++ b/diff-check/README.md @@ -1,9 +1,9 @@ -# diff-check - Git-to-deployment diff analyzer +# diff-check +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) ![Version](https://img.shields.io/badge/version-1.0.0--alpha-blue) -![License](https://img.shields.io/badge/license-MIT-green) -A secure, production-ready tool for comparing deployed application files against a Git repository branch to detect differences. Generates detailed reports of added, modified, and deleted files with support for binary artifact detection, multiple output formats, and comprehensive validation. +A Git repository vs. file system diff analyzer. ## Table of Contents diff --git a/server-audit/README.md b/server-audit/README.md index bd56568..980a2d1 100644 --- a/server-audit/README.md +++ b/server-audit/README.md @@ -1,7 +1,7 @@ -![Flygtaxi Logo](docs/assets/images/logo.svg) - -# Server Audit Tool +# `server-audit` +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) +![Version](https://img.shields.io/badge/version-1.0.0--alpha-blue) ![Coverage](https://img.shields.io/badge/coverage-47.0%25-red) A secure, modular server auditing tool for extensible binary checking. @@ -9,8 +9,6 @@ Requires explicit specification of which checkers to run via the `--check` flag Currently supports Java, Tomcat, and Apache detection with pluggable architecture for easy extension. Supports multiple Tomcat instances per server across standard installation paths: `/usr/local`, `/usr/share`, and `/opt`. -## Directory Structure - ## Table of Contents - [Usage](#usage) @@ -210,18 +208,6 @@ server-audit/ └── run_tests.sh # Complete test suite runner ``` -## Security Features - -- ✅ Command injection prevention -- ✅ SSH key validation and permission checks -- ✅ Secure temporary file handling -- ✅ Strict error handling (`set -euo pipefail`) -- ✅ Input validation and sanitization -- ✅ Configurable connection limits -- ✅ Proper signal handling and cleanup - -📋 **For version history and breaking changes, see [CHANGELOG.md](CHANGELOG.md)** - ## Strategy Pattern Architecture The tool uses the Strategy pattern for maximum extensibility and maintainability with dynamic checker loading: @@ -338,16 +324,6 @@ Without `fswatch`, the watch mode uses a lightweight polling fallback that check - `test_service_detection.sh` - Binary detection across different scenarios - `test_documentation.sh` - Help and documentation accuracy -## Benefits of Modular Structure - -1. **Maintainability**: Each module has a single responsibility -2. **Testability**: Individual functions can be tested in isolation with comprehensive test coverage -3. **Readability**: Main script is concise and focused -4. **Reusability**: Helper functions can be used by other scripts -5. **Debugging**: Easier to locate and fix issues in specific modules -6. **Explicit Control**: --check flag prevents accidental execution and ensures intentional checker selection -7. **Performance**: Only requested checkers are loaded and executed - ## Troubleshooting ### Common Issues