Skip to content

Commit 20ee3b6

Browse files
authored
docs: update README with v0.7.6 stats, Pages link, and completion info (#6)
- Add v0.7.6 version badge - Add Lines of Code badges (60K+ total, 42K+ Go) - Update project statistics with exact tokei results - Add GitHub Pages link for web documentation - Include shell completion installation instructions - Add comment ratio and multi-language stats - Update status to show current version - Add website and releases links
1 parent 3946b57 commit 20ee3b6

File tree

1 file changed

+29
-6
lines changed

1 file changed

+29
-6
lines changed

README.md

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@
66
77
[![Go Version](https://img.shields.io/badge/Go-1.21+-00ADD8?style=flat&logo=go)](https://go.dev/)
88
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
9-
[![Status](https://img.shields.io/badge/Status-Phase%205%20Complete-brightgreen.svg)](docs/implementation_plan_todo.md)
9+
[![Status](https://img.shields.io/badge/Status-v0.7.6-brightgreen.svg)](https://github.com/greysquirr3l/shadowforge/releases)
1010
[![Build](https://img.shields.io/badge/Build-Passing-success.svg)](https://github.com/greysquirr3l/shadowforge)
1111
[![Coverage](https://img.shields.io/badge/Coverage-66%25+-brightgreen.svg)](https://github.com/greysquirr3l/shadowforge)
12+
[![Lines of Code](https://img.shields.io/badge/Lines-60K+-blue.svg)](https://github.com/greysquirr3l/shadowforge)
13+
[![Go Code](https://img.shields.io/badge/Go%20Code-42K+-00ADD8.svg)](https://github.com/greysquirr3l/shadowforge)
1214

1315
**Shadowforge** is a production-grade quantum-resistant steganography tool that combines
1416
NIST-approved post-quantum cryptography, Reed-Solomon error correction, and multiple
@@ -61,14 +63,18 @@ with `K-of-N` threshold recovery.
6163

6264
## 📈 Project Statistics
6365

64-
- **Total Lines**: ~15,000+ (implementation + tests)
66+
- **Total Lines**: 60,322 (44,174 code, 6,654 comments, 9,494 blanks)
67+
- **Go Code**: 41,671 lines across 185 files
68+
- **Comment Ratio**: 13% (5,385 comment lines)
69+
- **Languages**: Go (primary), Python, Shell, Markdown, Makefile
6570
- **Bounded Contexts**: 8 (Crypto, Error Correction, Stego, Media, Analysis, Distribution, Reconstruction, Archive)
66-
- **Implementation Files**: 83+
67-
- **Test Files**: 50+
71+
- **Implementation Files**: 185+ Go files
72+
- **Test Files**: 50+ comprehensive test suites
6873
- **Test Coverage**: 85%+ (90%+ for crypto operations)
6974
- **Distribution Patterns**: 4 (all operational)
7075
- **Steganography Techniques**: 7/7 (100% complete)
7176
- **CLI Binary Size**: 8.2MB (fully self-contained)
77+
- **Shell Completions**: Bash, Fish, Zsh (all commands covered)
7278

7379
## 🏗️ Architecture
7480

@@ -193,6 +199,8 @@ to evade steganalysis detection.
193199

194200
## 📚 Documentation
195201

202+
**🌐 Web Documentation**: [greysquirr3l.github.io/shadowforge](https://greysquirr3l.github.io/shadowforge/)
203+
196204
Complete documentation available in [`docs/public/cli/`](docs/public/cli/):
197205

198206
**Getting Started:**
@@ -247,6 +255,17 @@ make build
247255

248256
# Run tests
249257
make test
258+
259+
# Optional: Install shell completions
260+
# Bash
261+
sudo cp scripts/completion/shadowforge.bash /etc/bash_completion.d/shadowforge
262+
263+
# Fish
264+
cp scripts/completion/shadowforge.fish ~/.config/fish/completions/shadowforge.fish
265+
266+
# Zsh
267+
cp scripts/completion/shadowforge.zsh ~/.zsh/completion/_shadowforge
268+
# Add to ~/.zshrc: fpath=(~/.zsh/completion $fpath)
250269
```
251270

252271
## 🚀 Quick Start
@@ -356,7 +375,9 @@ curl -X POST http://localhost:8080/api/v1/embed \
356375

357376
## 📊 Development Status
358377

359-
### Current Phase: **Phase 5 Complete — API deferred (future item); CI/CD + Homebrew prep underway**
378+
### Current Version: **v0.7.6** (December 2025)
379+
380+
### Current Phase: **Phase 5 Complete — CLI Production Ready**
360381

361382
| Phase | Status | Description |
362383
|-------|--------|-------------|
@@ -541,9 +562,11 @@ and security purposes only. Always comply with applicable laws and regulations.
541562

542563
## 🔗 Links
543564

565+
- **Website**: <https://greysquirr3l.github.io/shadowforge>
544566
- **GitHub**: <https://github.com/greysquirr3l/shadowforge>
545-
- **Documentation**: [docs/public/cli/architecture.md](docs/public/cli/architecture.md)
567+
- **Documentation**: [docs/public/cli/](https://greysquirr3l.github.io/shadowforge/cli/)
546568
- **Issues**: <https://github.com/greysquirr3l/shadowforge/issues>
569+
- **Releases**: <https://github.com/greysquirr3l/shadowforge/releases>
547570

548571
---
549572

0 commit comments

Comments
 (0)