Enrich README with architecture, examples, and full usage docs#7
Merged
Conversation
Go flag package supports -- implicitly but it was not part of the original interface. https://claude.ai/code/session_017FVUwA1eLEoNPWaFEtFxtn
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
변경사항\n\n- 아키텍처 다이어그램 추가 (두 노드 간 메시지 흐름)\n- 설치 방법 (바이너리 다운로드 / 소스 빌드, darwin/arm64 포함)\n- 모드 설명 (Command 모드, Stdin/Stdout 모드, Pipe 모드)\n- 사용 예시 (채팅, 원격 명령 실행, 파일 전송)\n- 보안 설명 (RSA + AES 암호화)\n- 환경변수 표
Note
Low Risk
Documentation-only changes; no runtime behavior or security logic is modified.
Overview
Expands
README.mdfrom a brief description into full user documentation: adds an architecture diagram and step-by-step flow, installation instructions (binaries + build-from-source), and a complete flags table (including-blocksizeand short options).Documents operating modes (command vs stdin/stdout vs
-pipe), provides practical examples (chat, remote shell, file transfer, custom Redis URL), and adds security/encryption and environment-variable reference sections.Written by Cursor Bugbot for commit 76a09d5. This will update automatically on new commits. Configure here.