Skip to content

Commit c792703

Browse files
Update README.md
1 parent a7ce25f commit c792703

File tree

1 file changed

+40
-35
lines changed

1 file changed

+40
-35
lines changed

README.md

Lines changed: 40 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -52,22 +52,12 @@ Available commands:
5252
- `status` - gets translation project details
5353
- `upload` - uploads translation files or translation keys
5454
- `download` - downloads translation files
55-
- `auto-translate` - starts [auto-translation](https://simplelocalize.io/auto-translation/) jobs
56-
- `pull` - downloads translation files from [Translation Hosting](https://simplelocalize.io/translation-hosting/)
57-
- `publish` - publishes translations to [Translation Hosting](https://simplelocalize.io/translation-hosting/)
55+
- `auto-translate` - auto-translates texts in the editor
56+
- `pull` - downloads translation files from translation hosting
57+
- `publish` - publishes translations to hosting environment
5858
- `purge` - removes all translation, translation keys and languages from the project
5959
- `extract` - finds and extracts translation keys in your project files
6060
61-
## Create configuration file
62-
63-
Command creates a sample configuration file in the current directory.
64-
The configuration file simplifies the usage of the command-line tool
65-
by providing a default configuration for the project and allowing to omit some parameters.
66-
67-
```shell
68-
simplelocalize init
69-
```
70-
7161
## Upload translations
7262
7363
Upload command takes your local files and uploads them to SimpleLocalize.
@@ -108,9 +98,11 @@ simplelocalize auto-translate
10898
10999
## Translation Hosting
110100
101+
There are two commands that operates on [translation hosting](https://simplelocalize.io/translation-hosting/) resources which is `publish` and `pull`.
102+
111103
### Publish translations
112104
113-
Publish command updates translations on [translation hosting](https://simplelocalize.io/translation-hosting/).
105+
Publish translations between translation editor and hosting or between hosting environments.
114106
115107
```
116108
simplelocalize publish
@@ -122,52 +114,65 @@ simplelocalize publish
122114
123115
### Pull resources
124116
125-
Downloads all translation hosting files to given directory in `--pullPath` parameter. It overwrites existing files and creates subdirectories if necessary.
117+
Pull command downloads files from translation hosting.
126118
127119
Pulls translations from the `_latest` environment.
128120
```properties
129-
simplelocalize pull --apiKey <PROJECT_API_KEY> --pullPath ./hosting/ --environment _latest
121+
simplelocalize pull
122+
--apiKey PROJECT_API_KEY
123+
--pullPath ./hosting/
124+
--environment _latest
130125
```
131126
132127
[GitHub Wiki: Pull resources](/simplelocalize/simplelocalize-cli/wiki/Translation-Hosting)
133128
134-
## Get project details
129+
## Additional commands
130+
131+
### Initalize configuration file
132+
133+
Command creates a sample configuration file in the current directory.
134+
135+
```shell
136+
simplelocalize init
137+
```
138+
139+
### Get project details
135140
136141
Command gets project details and prints them to the console.
137142
138-
```properties
139-
simplelocalize status --apiKey <PROJECT_API_KEY>
143+
```bash
144+
simplelocalize status --apiKey PROJECT_API_KEY
140145
```
141146
142-
## Purge translations
147+
[GitHub Wiki: Additional commands](https://github.com/simplelocalize/simplelocalize-cli/wiki/Additional-commands)
143148
144-
Command removes all translations, translation keys and languages from [Translation Editor](https://simplelocalize.io/translation-editor).
149+
### Purge translations
145150
146-
```properties
147-
simplelocalize purge --apiKey <PROJECT_API_KEY>
151+
Command removes all translations, translation keys and languages.
152+
153+
```bash
154+
simplelocalize purge --apiKey PROJECT_API_KEY
148155
```
149156
150-
**Additional parameters:**
151-
- `--force` allows you to skip confirmation prompt.
157+
[GitHub Wiki: Additional commands](https://github.com/simplelocalize/simplelocalize-cli/wiki/Additional-commands)
152158
153-
## Extract translation keys
159+
### Extract translation keys
154160
155-
Extract command finds translation keys and translations from project source code at `<SEARCH_DIRECTORY>` and exports them to `extraction.json` file that uses `simplelocalize-json` file format.
161+
Extract command finds translation keys and translations from the source code.
156162
157-
```properties
163+
```bash
158164
simplelocalize extract
159-
--searchDir <SEARCH_DIRECTOR>
160-
--projectType <PROJECT_TYPE>
165+
--searchDir SEARCH_DIRECTORY
166+
--projectType PROJECT_TYPE
161167
```
162168
163-
See [available project types](https://simplelocalize.io/docs/cli/i18n-keys-extraction/).
164-
169+
[GitHub Wiki: Additional commands](https://github.com/simplelocalize/simplelocalize-cli/wiki/Additional-commands)
165170
166171
## Configuration file
167-
Use configuration file to simplify your bash command.
172+
173+
Create configuration file to to simplify the bash commands.
168174
Arguments used in command always override properties set in the configuration file.
169-
By default, SimpleLocalize will load configuration from file named `simplelocalize.yml`.
170-
You can load configuration from different location by using a `-c` parameters.
175+
By default, SimpleLocalize loads configuration from `simplelocalize.yml` file.
171176
172177
```properties
173178
# Load default simplelocalize.yml file

0 commit comments

Comments
 (0)