diff --git a/README.md b/README.md index 3b4ee95..c1d6b04 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,32 @@ # Seoul -PHP dashboard that builds a service shortcut list from nginx configuration and local PHP entry points. +nginx 설정을 기반으로 서비스 바로가기 목록을 구성하는 PHP 대시보드입니다. -## Main Features +## 주요 기능 -- Reads nginx configuration paths and extracts HTTPS server blocks. -- Finds shallow PHP entries under document roots. -- Filters self links, internal names, IP literals, variables, and regex-like host values. -- Provides PWA metadata and service worker assets. +- nginx 설정 파일을 읽고 HTTPS server block의 host를 추출합니다. +- document root에서 얕은 PHP entry를 찾아 바로가기 목록으로 표시합니다. +- 자기 자신, 내부 이름, IP literal, 변수, 정규식 형태 host를 제외합니다. +- PWA manifest와 service worker를 제공합니다. -## Main Entry Points +## 주요 진입점 - `index.php` - `manifest.webmanifest` - `sw.js` -## Structure +## 구성 -- `index.php`: dashboard renderer. -- `manifest.webmanifest`: PWA manifest. -- `sw.js`: service worker. -- `assets/`: icons and static assets. +- `index.php`: 바로가기 대시보드 본체 +- `manifest.webmanifest`: PWA manifest +- `sw.js`: service worker +- `assets/`: 아이콘과 정적 자산 -## Notes +## 참고 -The `car/` directory is maintained as a separate repository and is intentionally ignored here. +`car/` 디렉터리는 별도 저장소로 관리하므로 이 저장소에서는 제외합니다. -## Security - -- nginx configuration is read for display only. -- Generated host and link values are escaped before rendering. +## 보안 +- nginx 설정 읽기는 표시용으로만 사용합니다. +- 생성된 host와 link 값은 렌더링 전에 escape합니다.