Skip to content

docs: explain Full vs Lite editions in README (#227) - #241

Merged
adamgell merged 1 commit into
mainfrom
fix/227-readme-editions
Jul 11, 2026
Merged

docs: explain Full vs Lite editions in README (#227)#241
adamgell merged 1 commit into
mainfrom
fix/227-readme-editions

Conversation

@adamgell

Copy link
Copy Markdown
Owner

Closes #227.

The README never explained the difference between the "full edition" and "lite edition" downloads. This adds an Editions: Full vs Lite section between Install and Features.

What it says

  • Full (default build): the log viewer plus every specialized workspace/tool — Intune Diagnostics, DSRegCmd, Software Deployment, Event Log Viewer, Sysmon, Secure Boot Certs, macOS Diagnostics, and Diagnostic Collection.
  • Lite (--no-default-features): the core log viewer plus Timeline and DNS/DHCP, with a smaller binary (drops the evtx/plist parsers and the specialized code).
  • Both read the same log formats.

Accuracy

Every claim is verified against the source of truth:

  • The Lite workspace set (log, timeline, dns-dhcp) matches get_available_workspaces in src-tauri/src/commands/app_config.rs with no features enabled.
  • The Full feature list matches the full feature in src-tauri/Cargo.toml.
  • Platform labels reflect each workspace's live-capture gating.

Docs-only change; ASCII-only per repo convention.

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings July 11, 2026 00:40

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds missing README documentation explaining the difference between the Full and Lite standalone downloads so users can choose the right build.

Changes:

  • Inserts an Editions: Full vs Lite section between Install and Features
  • Documents what each edition includes, with a Full feature table and a Lite summary
  • Notes that both editions read the same log formats/viewer behavior

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md

### Lite edition

The core log viewer only. It keeps everything under **Log Viewer** below - format auto-detection, real-time tailing, virtual scrolling, find and filter, text highlighting, and the embedded error-code database - plus the Timeline and DNS / DHCP tools. It leaves out the eight specialized features above, which also drops the Windows Event Log and property-list parsers and makes the binary noticeably smaller. Choose Lite if you just want a fast, portable, CMTrace-style log reader with a minimal footprint.
Add an "Editions: Full vs Lite" section between Install and Features
describing what each download includes. Full (default build) bundles all
specialized workspaces and tools; Lite (--no-default-features) is the core
log viewer plus Timeline and DNS/DHCP, with a smaller binary.

The workspace/feature claims are verified against get_available_workspaces
in commands/app_config.rs and the `full` feature in src-tauri/Cargo.toml.

Fixes #227

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@adamgell
adamgell force-pushed the fix/227-readme-editions branch from 3332e85 to 72c34ab Compare July 11, 2026 02:12
@adamgell
adamgell merged commit 96dae48 into main Jul 11, 2026
15 checks passed
@adamgell
adamgell deleted the fix/227-readme-editions branch July 11, 2026 02:35
adamgell added a commit that referenced this pull request Jul 13, 2026
Expand the [Unreleased] section to cover every commit since v1.3.2:

- Log Text column auto-fit on load (this branch)
- CCM type="0" first-class Success severity + empty-type coercion fix (#248)
- clippy --all-targets enforcement (#245)
- Full vs Lite editions README docs (#241)
- quick-xml RUSTSEC-2026-0194/0195 advisory ignore (#239) and the
  Microsoft Security DevOps workflow
- signed nightly build channel, updater feed, and failure alerting (#236)
- a Dependencies subsection with exact Rust / frontend / GitHub Actions
  version deltas

Version numbers and behavioral claims were taken from the commit diffs,
not the commit subjects.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Lite vs Full - what is the difference betewwn the versions.

2 participants