Skip to content

Commit 84277a1

Browse files
authored
Update README.md
1 parent 17bec54 commit 84277a1

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ curl -s https://get.simplelocalize.io/install | bash
2727
## Usage
2828

2929
```properties
30-
simplelocalize [COMMAND] --apiKey <PROJECT_API_KEY> rest of parameters...
30+
simplelocalize -c config.yml [COMMAND] --apiKey <PROJECT_API_KEY> --uploadaPath <UPLOAD_PATH> other arguments...
3131
```
3232

3333
## Example configuration file
34+
Use configuration file in order to simplify your bash command. Arguments used in command always overrides properties set in configuration file.
3435

3536
Filename: `simplelocalize.yml`
3637

@@ -58,7 +59,7 @@ ignoreKeys:
5859
- 'ABOUT-US'
5960
```
6061
61-
### One file with translations
62+
### Example: One file with translations
6263
6364
```bash
6465
.
@@ -73,7 +74,7 @@ uploadFormat: multi-language-json
7374
```
7475

7576

76-
### Single file with multiple language directories
77+
### Example: Single file with multiple language directories
7778

7879
```bash
7980
.
@@ -91,7 +92,7 @@ uploadPath: /{lang}/index.json
9192
uploadFormat: single-language-json
9293
```
9394

94-
### Multiple files with multiple language directories
95+
### Example: Multiple files with multiple language directories
9596

9697
```bash
9798
.
@@ -112,35 +113,35 @@ uploadPath: /{lang}/{ns}.json
112113
uploadFormat: single-language-json
113114
```
114115

115-
## Upload translations
116+
## Upload translations command
116117

117118
```properties
118119
simplelocalize upload --apiKey <PROJECT_API_KEY>
119120
```
120121

121122

122-
## Download translations
123+
## Download translations command
123124

124125
```properties
125126
simplelocalize download --apiKey <PROJECT_API_KEY>
126127
```
127128

128129

129-
## Sync translations
130+
## Sync translations command
130131
Sync command combines upload and download commend execution.
131132
```properties
132133
simplelocalize sync --apiKey <PROJECT_API_KEY>
133134
```
134135

135136

136-
## Extract translation keys
137+
## Extract translation keys command
137138

138139
```properties
139140
simplelocalize extract --apiKey <PROJECT_API_KEY>
140141
```
141142

142143
## Custom configuration file
143-
By default, SimpleLocalize will load configuration from file named `simplelocalize.yml`. You can load configuration from different location using `--configuration` parameters.
144+
By default, SimpleLocalize will load configuration from file named `simplelocalize.yml`. You can load configuration from different location using `-c` parameters.
144145

145146
```properties
146147
simplelocalize -c my-configuration.yml upload

0 commit comments

Comments
 (0)