Skip to content

Commit 06a63de

Browse files
authored
Update README.md
1 parent cdf1a6e commit 06a63de

File tree

1 file changed

+50
-17
lines changed

1 file changed

+50
-17
lines changed

README.md

Lines changed: 50 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ curl -s https://get.simplelocalize.io/install | bash
2626

2727
## Usage
2828

29-
```properties
30-
simplelocalize -c config.yml [COMMAND] --apiKey <PROJECT_API_KEY> --uploadaPath <UPLOAD_PATH> other arguments...
29+
```shell
30+
simplelocalize -c config.yml [COMMAND] --apiKey <PROJECT_API_KEY> ...
3131
```
3232

3333
## Configuration file
@@ -67,10 +67,12 @@ ignoreKeys:
6767
   └── messages.json
6868
```
6969

70-
Configuration:
70+
CLI command:
7171
```
72-
uploadPath: /locales/messages.json
73-
uploadFormat: multi-language-json
72+
simplelocalize upload
73+
--apiKey <PROJECT_API_KEY>
74+
--uploadPath /locales/messages.json
75+
--uploadFormat multi-language-json
7476
```
7577

7678

@@ -86,10 +88,12 @@ uploadFormat: multi-language-json
8688
└── index.json
8789
```
8890

89-
Configuration:
91+
CLI command:
9092
```
91-
uploadPath: /{lang}/index.json
92-
uploadFormat: single-language-json
93+
simplelocalize upload
94+
--apiKey <PROJECT_API_KEY>
95+
--uploadPath /{lang}/index.json
96+
--uploadFormat single-language-json
9397
```
9498

9599
### Example: Multiple files with multiple language directories
@@ -107,39 +111,68 @@ uploadFormat: single-language-json
107111
└── home.json
108112
```
109113

110-
Configuration:
114+
CLI command:
111115
```
112-
uploadPath: /{lang}/{ns}.json
113-
uploadFormat: single-language-json
116+
simplelocalize upload
117+
--apiKey <PROJECT_API_KEY>
118+
--uploadPath /{lang}/{ns}.json
119+
--uploadFormat single-language-json
114120
```
115121

116122
## Upload translations
117123

118-
```properties
119-
simplelocalize upload --apiKey <PROJECT_API_KEY>
124+
```shell
125+
simplelocalize upload
126+
--apiKey <PROJECT_API_KEY>
127+
--uploadPath <UPLOAD_PATH>
128+
--uploadFormat <UPLOAD_FORMAT>
129+
--uploadOptions <UPLOAD_OPTIONS>
120130
```
121131

132+
`--uploadOptions` parameter is optional.
133+
134+
Learn more about [upload translations command](https://simplelocalize.io/docs/cli/upload-translations/).
122135

123136
## Download translations
124137

125-
```properties
126-
simplelocalize download --apiKey <PROJECT_API_KEY>
138+
```shell
139+
simplelocalize download
140+
--apiKey <PROJECT_API_KEY>
141+
--downloadPath <DOWNLOAD_PATH>
142+
--downloadFormat <DOWNLOAD_FORMAT>
143+
--downloadOptions <DOWNLOAD_OPTIONS>
127144
```
128145

146+
`--downloadOptions` parameter is optional.
147+
148+
Learn more about [download translations command](https://simplelocalize.io/docs/cli/download-translations/).
129149

130150
## Sync translations
131151
Sync command combines upload and download commend execution.
132152
```properties
133-
simplelocalize sync --apiKey <PROJECT_API_KEY>
153+
simplelocalize sync
154+
--apiKey <PROJECT_API_KEY>
155+
--downloadPath <DOWNLOAD_PATH>
156+
--downloadFormat <DOWNLOAD_FORMAT>
157+
--downloadOptions <DOWNLOAD_OPTIONS>
158+
--uploadPath <UPLOAD_PATH>
159+
--uploadFormat <UPLOAD_FORMAT>
160+
--uploadOptions <UPLOAD_OPTIONS>
134161
```
135162

163+
`--downloadOptions` and `--uploadOptions` parameters are optional.
136164

137165
## Extract translation keys
138166

139167
```properties
140-
simplelocalize extract --apiKey <PROJECT_API_KEY>
168+
simplelocalize extract
169+
--apiKey <PROJECT_API_KEY>
170+
--searchDir <SEARCH_DIRECTOR>
171+
--projectType <PROJECT_TYPE>
141172
```
142173

174+
See [available project types](https://simplelocalize.io/docs/cli/i18n-keys-extraction/).
175+
143176
## Custom configuration file
144177
By default, SimpleLocalize will load configuration from file named `simplelocalize.yml`. You can load configuration from different location using `-c` parameters.
145178

0 commit comments

Comments
 (0)