Skip to content

Docs: README 업데이트#78

Merged
juiuj merged 1 commit intomainfrom
docs/husk-readme-update
Jan 28, 2026
Merged

Docs: README 업데이트#78
juiuj merged 1 commit intomainfrom
docs/husk-readme-update

Conversation

@juiuj
Copy link
Copy Markdown
Member

@juiuj juiuj commented Jan 28, 2026

Motivation

  • 타 프로젝트 진행에 따라 HUSK 리드미를 따로 분리하고자 함

Summary by CodeRabbit

릴리스 노트

  • 문서
    • README를 제품 중심 콘텐츠로 리뉴얼하였습니다.
    • HusK 브랜딩 및 서비스 소개를 추가하였습니다.
    • SSH 키체인 관리, 브라우저 기반 터미널, 암호화 연결 등 주요 기능을 설명하였습니다.
    • 시스템 아키텍처 및 기술 스택 정보를 포함하였습니다.

✏️ Tip: You can customize this high-level summary in your review settings.

Updated project description and added service details.
@juiuj juiuj requested review from Jsplix and soooheeee January 28, 2026 14:42
@juiuj juiuj self-assigned this Jan 28, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jan 28, 2026

📝 Walkthrough

개요 (Walkthrough)

README.md 파일이 Create React App 기본 보일러플레이트에서 HusK 서비스 중심의 마케팅/소개 문서로 전환되었습니다. 기존 npm 스크립트 및 배포 가이드 섹션이 제거되고, 서비스 기획 배경, 시스템 아키텍처, 기술 스택 등 제품 중심의 설명과 시각 자료가 추가되었습니다. 전체 41개 라인이 추가되고 56개 라인이 제거되었습니다.

코드 리뷰 예상 소요 시간

🎯 2 (Simple) | ⏱️ ~12 분


피드백 및 개선 사항

명확한 피드백:

README 파일이 개발자 온보딩 문서에서 제품 소개 문서로 성공적으로 전환되었습니다. 다만 다음 사항들을 검토하시기 바랍니다:

1. 개발자 가이드 재구성

  • 현황: 기존 npm start, npm test 등 개발 스크립트 문서가 완전히 제거됨
  • 개선 방법: 제품 소개 섹션 하단에 "개발 환경 설정" 또는 "로컬 개발 가이드" 섹션을 별도로 추가하여, 새로운 기여자들이 프로젝트를 로컬에서 실행할 수 있도록 안내하세요
  • 참고: GitHub README Best Practices에서는 설치 및 사용 지침을 필수 섹션으로 권장합니다

2. 기술 스택 섹션 상세화

  • 현황: "기술 스택" 섹션이 제목만 있고 구체적인 기술 목록이 없을 수 있음
  • 개선 방법: 프론트엔드(React, TypeScript), 백엔드, 보안 라이브러리 등 사용 중인 주요 기술들을 명시하면 개발자들의 빠른 이해를 도울 수 있습니다

3. 한영 이중 언어 구성 고려

  • 현황: 한국어 제목과 설명으로만 구성됨
  • 개선 방법: 영문 사용자도 접근 가능하도록 한영 이중 섹션 제공을 검토하세요. 이는 오픈소스 프로젝트의 확장성을 높입니다

이러한 개선을 통해 제품 소개와 개발자 친화성을 모두 확보할 수 있을 것으로 기대됩니다.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed PR 제목이 변경 내용과 완벽하게 일치하며, 명확하게 README 업데이트라는 핵심 변경사항을 요약하고 있습니다.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@aws-amplify-ap-northeast-2
Copy link
Copy Markdown

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-78.d15ua1f8x2sllg.amplifyapp.com

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@README.md`:
- Around line 31-34: Update the README’s "🔒 **보안 중심 설계**" section to correct
the misleading "종단 간 암호화" wording: change the line that currently says "WSS 기반
종단 간 암호화" to explicitly "WSS 기반 전송 구간 암호화 (TLS)" and add a brief clarifier that
WSS/TLS protects transport only and that AES-based server-side encryption (the
existing "키 등록 시 AES 기반 서버측 암호화" point) and key management occur/terminate on
the server unless client-side encryption is implemented; apply the same wording
corrections to the other occurrence mentioned (lines 46-49) so all references
accurately state transport-level (TLS) encryption and the scope of key
management.
🧹 Nitpick comments (1)
README.md (1)

3-7: README 이미지 링크의 장기 안정성 개선 권장

원인: github.com/user-attachments 링크는 이슈/PR 첨부 용도라 장기적으로 링크 변경/삭제 위험이 있습니다.
개선: 저장소 내 /assets 폴더에 이미지 커밋 후 상대 경로로 참조하는 방식을 권장합니다.

참고 개념/문서: GitHub Docs의 README에서 상대 경로로 이미지 참조 가이드.

Also applies to: 15-15, 55-59, 63-63

Comment on lines +31 to +34
- 🔒 **보안 중심 설계**
- 키 등록 시 AES 기반 서버측 암호화 처리
- WSS 기반 종단 간 암호화
<br/>
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

보안 설명에서 “종단 간 암호화(E2EE)” 표현 수정 필요

원인: WSS는 TLS 기반 전송 구간 암호화이며, 클라이언트-서버 간 TLS 종단에서 종료되므로 E2EE와는 다릅니다.
개선: “종단 간 암호화” 대신 “전송 구간 암호화(TLS)”로 명확히 표기하고, 키 관리/암호화 범위를 실제 구현 수준에 맞춰 구체화해주세요.

✅ 제안 수정안
-- 🔒 **보안 중심 설계**
-  - 키 등록 시 AES 기반 서버측 암호화 처리
-  - WSS 기반 종단 간 암호화
+- 🔒 **보안 중심 설계**
+  - 키 등록 시 AES 기반 서버측 암호화 처리
+  - WSS(TLS) 기반 전송 구간 암호화

참고 개념/문서: MDN의 WebSocket Secure (WSS)TLS 전송 구간 암호화 설명 기준.

Also applies to: 46-49

🤖 Prompt for AI Agents
In `@README.md` around lines 31 - 34, Update the README’s "🔒 **보안 중심 설계**"
section to correct the misleading "종단 간 암호화" wording: change the line that
currently says "WSS 기반 종단 간 암호화" to explicitly "WSS 기반 전송 구간 암호화 (TLS)" and add
a brief clarifier that WSS/TLS protects transport only and that AES-based
server-side encryption (the existing "키 등록 시 AES 기반 서버측 암호화" point) and key
management occur/terminate on the server unless client-side encryption is
implemented; apply the same wording corrections to the other occurrence
mentioned (lines 46-49) so all references accurately state transport-level (TLS)
encryption and the scope of key management.

Copy link
Copy Markdown
Contributor

@Jsplix Jsplix left a comment

Choose a reason for hiding this comment

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

확인했습니다~

@juiuj juiuj merged commit ec1fb97 into main Jan 28, 2026
3 checks passed
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.

2 participants