Skip to content

Commit 6dc335e

Browse files
committed
README: 한국어로 사용법 및 명령줄 옵션 설명 추가
1 parent 9614955 commit 6dc335e

File tree

1 file changed

+20
-86
lines changed

1 file changed

+20
-86
lines changed

README.md

Lines changed: 20 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,52 @@
11
# staticup
22

3-
A simple CLI tool for uploading files to static file hosting services.
3+
정적 파일 호스팅 서비스에 파일을 업로드하기 위한 간단한 CLI 도구입니다.
44

5-
## Installation
5+
## 사용법
66

7-
### From Source
7+
### 기본 업로드
88

9-
```bash
10-
go install github.com/DevNergis/staticup@latest
11-
```
12-
13-
Or clone and build:
14-
15-
```bash
16-
git clone https://github.com/DevNergis/staticup.git
17-
cd staticup
18-
make build
19-
```
20-
21-
Or use Go directly:
22-
23-
```bash
24-
git clone https://github.com/DevNergis/staticup.git
25-
cd staticup
26-
go build -o staticup
27-
```
28-
29-
### Using Make
30-
31-
The project includes a Makefile for common tasks:
32-
33-
```bash
34-
make help # Show available commands
35-
make build # Build the binary
36-
make install # Install to /usr/local/bin (requires sudo)
37-
make clean # Remove built binary
38-
make fmt # Format the code
39-
make vet # Run go vet
40-
```
41-
42-
## Usage
43-
44-
### Basic Upload
45-
46-
Upload a file directly:
9+
파일을 직접 업로드:
4710

4811
```bash
4912
staticup /path/to/your/file.txt
5013
```
5114

52-
Or using the `--file` flag:
15+
또는 `--file` 플래그 사용:
5316

5417
```bash
5518
staticup --file /path/to/your/file.txt
5619
```
5720

58-
### Custom API Endpoint
59-
60-
Specify a custom API endpoint:
61-
62-
```bash
63-
staticup /path/to/your/file.txt --api https://your-api.example.com
64-
```
21+
## 명령줄 옵션
6522

66-
### With Authentication
23+
- `<file-path>` (위치 인자): 업로드할 파일의 경로
24+
- `--file`: 업로드할 파일의 경로 (위치 인자 대신 사용 가능)
25+
- `--verbose`: 상세 출력 활성화
26+
- `--version`: 버전 정보 표시
6727

68-
If the API requires authentication:
28+
## 예제
6929

7030
```bash
71-
staticup /path/to/your/file.txt --key YOUR_API_KEY
72-
```
73-
74-
### Verbose Output
75-
76-
Enable verbose logging to see detailed information:
77-
78-
```bash
79-
staticup /path/to/your/file.txt --verbose
80-
```
81-
82-
## Command-Line Options
83-
84-
- `<file-path>` (positional): Path to the file to upload
85-
- `--file`: Path to the file to upload (alternative to positional argument)
86-
- `--api`: API endpoint URL (default: https://static.a85labs.net)
87-
- `--key`: API key for authentication (optional)
88-
- `--verbose`: Enable verbose output
89-
- `--version`: Show version information
90-
91-
## Examples
92-
93-
```bash
94-
# Upload an image (positional argument)
31+
# 이미지 업로드 (위치 인자)
9532
staticup photo.jpg
9633

97-
# Upload with verbose output
34+
# 상세 출력과 함께 업로드
9835
staticup document.pdf --verbose
9936

100-
# Upload to custom endpoint with API key
101-
staticup data.json --api https://custom-static.example.com --key abc123
102-
103-
# Check version
37+
# 버전 확인
10438
staticup --version
10539
```
10640

10741
## API
10842

109-
This tool is designed to work with the API at https://static.a85labs.net/openapi.json
43+
이 도구는 https://static.a85labs.net/docs 에 있는 API와 함께 작동하도록 설계되었습니다.
11044

111-
The tool expects the API to:
112-
- Accept POST requests to `/upload` endpoint
113-
- Support multipart/form-data file uploads
114-
- Return a JSON response with the uploaded file URL
45+
이 도구는 API가 다음을 수행할 것으로 예상합니다:
46+
- `/upload` 엔드포인트로 POST 요청 수락
47+
- multipart/form-data 파일 업로드 지원
48+
- 업로드된 파일 URL이 포함된 JSON 응답 반환
11549

116-
## License
50+
## 라이선스
11751

11852
AGPL-3.0

0 commit comments

Comments
 (0)