Skip to content

Commit 17bec54

Browse files
authored
Update README.md
1 parent 483eff3 commit 17bec54

File tree

1 file changed

+58
-4
lines changed

1 file changed

+58
-4
lines changed

README.md

Lines changed: 58 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,28 +58,82 @@ ignoreKeys:
5858
- 'ABOUT-US'
5959
```
6060
61-
## Upload Translations
61+
### One file with translations
62+
63+
```bash
64+
.
65+
└── locales
66+
   └── messages.json
67+
```
68+
69+
Configuration:
70+
```
71+
uploadPath: /locales/messages.json
72+
uploadFormat: multi-language-json
73+
```
74+
75+
76+
### Single file with multiple language directories
77+
78+
```bash
79+
.
80+
├── ca
81+
│   └── index.json
82+
├── en
83+
│   └── index.json
84+
└── es
85+
└── index.json
86+
```
87+
88+
Configuration:
89+
```
90+
uploadPath: /{lang}/index.json
91+
uploadFormat: single-language-json
92+
```
93+
94+
### Multiple files with multiple language directories
95+
96+
```bash
97+
.
98+
├── ca
99+
│   ├── common.json
100+
│   └── home.json
101+
├── en
102+
│   ├── common.json
103+
│   └── home.json
104+
└── es
105+
├── common.json
106+
└── home.json
107+
```
108+
109+
Configuration:
110+
```
111+
uploadPath: /{lang}/{ns}.json
112+
uploadFormat: single-language-json
113+
```
114+
115+
## Upload translations
62116

63117
```properties
64118
simplelocalize upload --apiKey <PROJECT_API_KEY>
65119
```
66120

67121

68-
## Download Translations
122+
## Download translations
69123

70124
```properties
71125
simplelocalize download --apiKey <PROJECT_API_KEY>
72126
```
73127

74128

75-
## Sync Translations
129+
## Sync translations
76130
Sync command combines upload and download commend execution.
77131
```properties
78132
simplelocalize sync --apiKey <PROJECT_API_KEY>
79133
```
80134

81135

82-
## Extract Translation Keys
136+
## Extract translation keys
83137

84138
```properties
85139
simplelocalize extract --apiKey <PROJECT_API_KEY>

0 commit comments

Comments
 (0)