Skip to content

docs: rewrite README for janost fork#2

Merged
janost merged 3 commits into
masterfrom
docs/readme-update
Mar 19, 2026
Merged

docs: rewrite README for janost fork#2
janost merged 3 commits into
masterfrom
docs/readme-update

Conversation

@janost

@janost janost commented Mar 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Fix CI and deps.rs badges to point to janost/neolink
  • Mention Frigate as NVR software alongside Blue Iris and Shinobi
  • Document Docker/GHCR as the preferred installation method
  • Remove binary release references
  • Document new fork features (low-latency, enable_audio, disk management, encoding)
  • Add RTSP client connection URL example
  • Condense from 622 to 241 lines (~61% shorter)

Test plan

  • Verify badge images render on GitHub
  • Verify deps.rs link resolves
  • Verify sample_config.toml link works
  • Review rendered markdown for formatting issues

🤖 Generated with Claude Code

janost and others added 3 commits March 19, 2026 15:00
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Create docs/mqtt.md with full MQTT message reference, HA discovery,
  and runtime control via MQTT
- Create docs/commands.md with detailed CLI subcommand reference
  including talk, PTZ presets, encoding, and disk management
- Create docs/configuration.md with full config reference including
  TLS, users, discovery details, pause/idle disconnect
- Add documentation links section to README
- Restore donations section with note that upstream is unmaintained
- Add paths-ignore for *.md and docs/** to both Docker workflows

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@janost janost merged commit 2852f22 into master Mar 19, 2026
1 check passed
@janost janost deleted the docs/readme-update branch March 19, 2026 14:30
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.

1 participant