Skip to content

Commit 1dcc618

Browse files
committed
Update README.md
1 parent 722d109 commit 1dcc618

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,53 @@
11
# browser-sdk-generator
22

3+
YAML 스키마 파일을 기반으로 다양한 환경의 포트원 SDK 코드를 자동 생성하는 도구입니다.
4+
5+
## 프로젝트 구조
6+
7+
```
8+
crates/
9+
├── browser_sdk_schema/ # 핵심 스키마 정의 및 파싱 라이브러리
10+
├── generator_cli/ # 메인 CLI 애플리케이션
11+
├── browser_sdk_ts_codegen/ # TypeScript 코드 생성기
12+
├── browser_sdk_dart_codegen/ # Dart 코드 생성기
13+
└── ...
14+
```
15+
16+
## 빠른 시작
17+
18+
### 사전 요구사항
19+
320
```sh
421
# nextest 설치
522
cargo install cargo-nextest
623
```
724

25+
### 개발 워크플로우
26+
827
```sh
9-
# schema.json 재생성
28+
# browser-sdk.schema.json 재생성
1029
cargo run -p browser_sdk_schema --bin generate_schema
1130

1231
# 테스트 실행
1332
cargo nextest run --workspace
1433

15-
# ./output 디렉토리에 typescript 코드 생성
34+
# TypeScript 코드 생성
1635
cargo run -p generator_cli generate --schema ./browser-sdk.yml --generator typescript ./output
36+
37+
# Dart 코드 생성
38+
cargo run -p generator_cli generate --schema ./browser-sdk.yml --generator dart ./output
1739
```
1840

41+
## 스키마 파일
42+
43+
- `browser-sdk.yml`: 메인 스키마 정의 파일
44+
- `browser-sdk.schema.json`: IDE 지원을 위한 JSON 스키마 파일
45+
46+
## 지원 언어
47+
48+
- **TypeScript**: 브라우저용 포트원 SDK
49+
- **Dart**: Flutter용 포트원 SDK
50+
1951
이 프로젝트는 [GNU Affero General Public License v3.0] 또는 그 이후 버전에 따라 라이센스가 부여됩니다. 자세한 내용은 [COPYRIGHT] 파일을 참고하세요.
2052

2153
[GNU Affero General Public License v3.0]: LICENSE

0 commit comments

Comments
 (0)