Skip to content

Commit 553ca95

Browse files
committed
docs: update README for unified backend and concurrency (from feature branch)
1 parent 7501ac1 commit 553ca95

File tree

1 file changed

+51
-2
lines changed

1 file changed

+51
-2
lines changed

README.md

Lines changed: 51 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@
88

99
---
1010

11+
## 🚀 Why Use CodeSleuth?
12+
13+
Enterprise COBOL codebases are often large, undocumented, and hard to modernize. CodeSleuth automates structural analysis, dead code detection, and documentation — helping teams audit, refactor, or migrate legacy COBOL more confidently.
14+
15+
---
16+
17+
> **Note:**
18+
> This is the `main` branch. It currently uses a single-threaded Go CLI and separate Rust parser/summarizer binaries. **Unified backend and concurrency are available on the [`feat/concurrency-worker-pool`](https://github.com/Cod-e-Codes/codesleuth/tree/feat/concurrency-worker-pool) branch and will be merged soon.**
19+
20+
---
21+
1122
## Features
1223

1324
- **COBOL Parsing:** Rust-based parser for extracting program structure and metadata
@@ -26,6 +37,38 @@
2637
- **Rust Summarizer** (`summarizer/`): Consumes IR and generates Markdown reports
2738
- **Go CLI** (`cmd/`): Orchestrates parsing and summarization, providing a user-facing CLI
2839

40+
> **Upcoming:**
41+
> The next release will unify the Rust backend and add concurrent file analysis, as already available on the feature branch.
42+
43+
---
44+
45+
## 🔧 Project Status
46+
47+
This is a **work-in-progress alpha**. The `main` branch is stable for single-file and small-batch COBOL analysis. **Unified backend and concurrency are being actively tested on the feature branch and will be merged after further bug fixes.**
48+
49+
---
50+
51+
## 📄 Example Output
52+
53+
```markdown
54+
# COBOL Program Summary
55+
56+
**Program Name:** PAYROLL01
57+
**Author:** Jane Doe
58+
**Working-Storage:** 28 variables
59+
**Dead Code Detected:** 3 paragraphs
60+
61+
## Control Flow
62+
63+
```
64+
65+
```mermaid
66+
graph TD
67+
Start --> Validate
68+
Validate --> Process
69+
Process --> End
70+
```
71+
2972
---
3073

3174
## Installation
@@ -70,6 +113,12 @@ cd cmd && go build -o codesleuth && cd ..
70113

71114
# Output analysis to a Markdown file
72115
./cmd/codesleuth.exe analyze path/to/your/cobol/files > analysis_report.md
116+
117+
# Output per-file Markdown to a directory
118+
./cmd/codesleuth.exe analyze --output ./summaries path/to/your/cobol/files
119+
120+
# Output JSON instead of Markdown
121+
./cmd/codesleuth.exe analyze --json path/to/your/cobol/files
73122
```
74123

75124
---
@@ -108,7 +157,7 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
108157

109158
## Roadmap & Future Enhancements
110159

111-
- **Concurrency:** Planned support for parallel analysis of multiple files to improve performance on large codebases.
160+
- **Unified Backend & Concurrency:** Planned for the next release (see feature branch for early access)
112161
- **Configurable Output:** More options for customizing report formats and output destinations.
113162
- **Plugin System:** Extensible architecture for custom analysis or reporting plugins.
114163
- **Improved Error Handling:** More robust diagnostics and user feedback for parsing and analysis errors.
@@ -117,4 +166,4 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
117166

118167
---
119168

120-
*Built for maintainers and developers working with legacy COBOL systems.*
169+
*Built for maintainers and developers working with legacy COBOL systems.*

0 commit comments

Comments
 (0)