Skip to content

Commit 33077db

Browse files
committed
Add README.md
1 parent d97e144 commit 33077db

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,50 @@
11
# poeditor-cli
2+
3+
[![Gem](https://img.shields.io/gem/v/cocoaseeds.svg)](https://rubygems.org/gems/cocoaseeds)
4+
[![Build Status](https://travis-ci.org/StyleShare/poeditor-cli.svg?branch=master)](https://travis-ci.org/StyleShare/poeditor-cli)
5+
6+
Command line application for [POEditor](https://poeditor.com).
7+
8+
<img width="682" alt="poeditor-cli" src="https://cloud.githubusercontent.com/assets/931655/22509884/2aebebc2-e8d3-11e6-86e2-a9915ca755b5.png">
9+
10+
## Installation
11+
12+
```console
13+
$ [sudo] gem install poeditor-cli
14+
```
15+
16+
## Usage
17+
18+
1. **Create `poeditor.yml` file**
19+
20+
Here is an example.
21+
22+
```yaml
23+
api_key: YOUR_API_KEY
24+
project_id: PROJECT_ID
25+
languages: [en, ko, jp, zh-Hans, zh-Hant, fr, es]
26+
path: example/Resources/{LANGUAGE}.lproj/Localizable.strings
27+
type: apple_strings
28+
tags: [ios] # optional
29+
```
30+
31+
| Field | Description |
32+
|---|---|
33+
| `api_key` | Your POEditor API key. You can check it on [POEditor API Access](https://poeditor.com/account/api). |
34+
| `project_id` | POEditor project ID. You can check this value on the web browser's address bar.<br />For example: `https://poeditor.com/projects/view?id=XXXXX` |
35+
| `languages` | Language codes to export. Use your project's language code.<br />For example, use `zh-Hans` if you're working on Xcode project even though POEditor uses `zh-CN` for simplified chinese. |
36+
| `path` | The path for translation files to be downloaded. Each values of `languages` will be used for filling `{LANGUAGE}` placeholder. |
37+
| `type` | Translation file format. (po, pot, mo, xls, csv, resw, resx, android_strings, apple_strings, xliff, properties, key_value_json, json, xmb, xtb) |
38+
| `tags` | (Optional) Terms which contain whole tags will be exported. (`&&`) |
39+
40+
2. **Export using CLI**
41+
42+
```console
43+
$ poeditor export
44+
```
45+
46+
3. **You're done! 🎉**
47+
48+
## License
49+
50+
**poeditor-cli** is written by [Suyeol Jeon](https://github.com/devxoul) and available under MIT license.

0 commit comments

Comments
 (0)