diff --git a/README.md b/README.md index 0331edd..dc306de 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,32 @@ # Financial -PHP based personal finance service for accounts, transactions, categories, installments, loans, recurring transactions, and merchant classification rules. +계좌, 거래, 카테고리, 할부, 대출, 반복거래, 가맹점 자동분류 규칙을 관리하는 PHP 기반 개인 금융 관리 서비스입니다. -## Main Features +## 주요 기능 -- Server-rendered authenticated screens for personal finance data. -- Account, transaction, installment, loan, recurring transaction, and merchant rule management. -- CSRF protected form POST workflows. -- Category suggestion API based on merchant rules and confidence. +- 서버 렌더링 PHP 화면으로 개인 금융 데이터를 조회하고 저장합니다. +- 계좌, 거래, 할부, 대출, 반복거래, 가맹점 규칙을 관리합니다. +- 로그인 세션, remember token, CSRF 검증을 사용합니다. +- 가맹점 규칙과 confidence 기반 카테고리 추천 API를 제공합니다. -## Main APIs +## 주요 API - `public/api/category_suggest.php` -- Standard authenticated form POST save flows. +- 인증된 일반 form POST 저장 흐름 -## Structure +## 구성 -- `app/config/database.php`: DB config bridge. -- `app/lib/auth.php`: authentication, remember token, CSRF, and no-store headers. -- `app/lib/*_service.php`: domain services. -- `public/*.php`: screens and form handlers. +- `app/config/database.php`: DB 설정 bridge +- `app/lib/auth.php`: 인증, remember token, CSRF, no-store header +- `app/lib/*_service.php`: 계좌/거래/할부/대출/반복거래 서비스 로직 +- `public/*.php`: 사용자 화면과 form 처리 -## Secrets +## Secret -DB credentials are loaded from `/home/seo/secret/financial.php`. Do not commit that file. +DB 접속 정보는 `/home/seo/secret/financial.php`에서 로드합니다. 이 파일은 저장소에 포함하지 않습니다. -## Security - -- Uses login sessions and remember tokens. -- POST forms validate CSRF tokens. -- Personal financial responses should remain private and no-store. +## 보안 +- 로그인 세션과 remember token을 사용합니다. +- POST form은 CSRF token을 검증합니다. +- 개인 금융 데이터 응답은 private/no-store 상태를 유지해야 합니다.