Skip to content

Commit 8309314

Browse files
authored
Update README.md
1 parent 0f6ea0c commit 8309314

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

README.md

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,7 @@ simplelocalize sync
135135
Auto-translate command starts [auto-translation](https://simplelocalize.io/auto-translation) jobs.
136136
137137
```properties
138-
simplelocalize auto-translate
139-
--apiKey <PROJECT_API_KEY>
138+
simplelocalize auto-translate --apiKey <PROJECT_API_KEY>
140139
```
141140
142141
Additional parameters:
@@ -220,44 +219,46 @@ simplelocalize upload
220219
--uploadFormat single-language-json
221220
```
222221
223-
## Pull resources from Translation Hosting
224222
225-
Downloads all translation hosting files to given directory in `--pullPath` parameter. It overwrites existing files and creates subdirectories if necessary. Available environment variables: `latest`, `production`.
223+
## Translation Hosting: Publish translations
226224
227-
```
228-
simplelocalize pull
229-
--apiKey <PROJECT_API_KEY>
230-
--pullPath ./hosting/
231-
--environment latest
225+
It publishes translation to [Translation Hosting](https://simplelocalize.io/translation-hosting). It behaves exactly the same as publish buttons in the SimpleLocalize (Hosting tab).
226+
227+
Publishes translations from Translation Editor to the `latest` environment.
228+
```properties
229+
simplelocalize publish --apiKey <PROJECT_API_KEY> --environment latest
232230
```
233231
234-
Additional parameters:
235-
`--filterRegex` allows you to filter files by regex, e.g.: `--filterRegex '__index.json'` will download only `__index.json` file.
232+
Publishes translations from the `latest` environment to `production` environment.
233+
```properties
234+
simplelocalize publish --apiKey <PROJECT_API_KEY> --environment production
235+
```
236236
237-
## Publish resources to Translation Hosting
237+
## Translation Hosting: Pull resources
238238
239-
It publishes translation to [Translation Hosting](https://simplelocalize.io/translation-hosting). It behaves exactly the same as publish buttons in the SimpleLocalize (Hosting tab).
239+
Downloads all translation hosting files to given directory in `--pullPath` parameter. It overwrites existing files and creates subdirectories if necessary.
240240
241+
Pulls translations from the `latest` environment.
242+
```properties
243+
simplelocalize pull --apiKey <PROJECT_API_KEY> --pullPath ./hosting/ --environment latest
241244
```
242-
simplelocalize publish
243-
--apiKey <PROJECT_API_KEY>
244-
--environment latest
245+
246+
Pulls translations from the `production` environment.
247+
```properties
248+
simplelocalize pull --apiKey <PROJECT_API_KEY> --pullPath ./hosting/ --environment production
245249
```
246250
247-
- `--environment latest` gets translations from Translation Editor and publishes them to Translation Hosting to `latest` environment.
248-
- `--environment production` gets translations from Translation Hosting (`latest`) and publishes them to Translation Hosting (`production`).
251+
If you would like to filter files which should be downloaded you can use `--filterRegex` param,
252+
e.g.: `--filterRegex '__index.json'` will download only `__index.json` file.
253+
249254
250-
```
251-
(Translation Editor) --> ('latest' environment) --> ('production' environment)
252-
```
253255
254256
## Getting project details
255257
256258
Command gets project details and prints them to the console.
257259
258-
```
259-
simplelocalize status
260-
--apiKey <PROJECT_API_KEY>
260+
```properties
261+
simplelocalize status --apiKey <PROJECT_API_KEY>
261262
```
262263
263264

0 commit comments

Comments
 (0)