Skip to content

Commit fe272ef

Browse files
authored
Update README.md
1 parent a2ee4fe commit fe272ef

File tree

1 file changed

+16
-108
lines changed

1 file changed

+16
-108
lines changed

README.md

Lines changed: 16 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
![logo](https://simplelocalize.io/public/github-banner-cli.png)
2-
3-
Learn more about us on [our website](https://simplelocalize.io).
1+
![logo](https://simplelocalize.io/cli/get-started/get-started.png)
42

53
![Tests](https://github.com/simplelocalize/simplelocalize-cli/workflows/Run%20Tests/badge.svg)
64
![Build native executables](https://github.com/simplelocalize/simplelocalize-cli/workflows/Build%20executables/badge.svg?branch=master)
@@ -9,121 +7,31 @@ Learn more about us on [our website](https://simplelocalize.io).
97

108
## What it does?
119

12-
We've built SimpleLocalize CLI that extracts i18n terms from your project files, and pushes them to the [SimpleLocalize](https://app.simplelocalize.io), where you can to translate it, and publish to the CDN or export in a desired format.
13-
14-
### Features:
15-
- extract i18n keys from project using [SimpleLocalize CLI](https://github.com/simplelocalize/simplelocalize-cli)
16-
- manage translations using [SimpleLocalize.io Platform](https://simplelocalize.io)
17-
- fetch ready to use translations from [SimpleLocalize CDN](https://simplelocalize.io/cdn) in desired format
18-
- **bring your i18n library of choice**
19-
- **no vendor lock-in**
20-
21-
### Example
22-
For example to translate frontend application in [ReactJS](https://github.com/facebook/react) you can use 3rd party library like [yahoo/react-intl](https://github.com/yahoo/react-intl):
23-
24-
Example [yahoo/react-intl](https://github.com/yahoo/react-intl) usage in code:
25-
```jsx
26-
<FormattedMessage id="LOGIN"/>
27-
```
28-
29-
Thanks to [SimpleLocalize.io CLI](https://github.com/simplelocalize/simplelocalize-cli), key: `LOGIN` will be found and pushed to the [SimpleLocalize Platform](https://app.simplelocalize.io) automatically.
10+
SimpleLocalize CLI to simplifies the process of translation in web apps, mobile apps, and games. It can:
11+
- find translation keys in your local files
12+
- upload existing translation files or transaltion keys
13+
- download translation file in ready to use format for already used i18n library like: i18next, Android, iOS, and many others
3014

31-
## 🚀 How to use it
3215

33-
* [Create a new project](https://app.simplelocalize.io/dashboard)
34-
* [Download `simplelocalize.yml` file](https://i.imgur.com/7LFtHeG.png)
35-
* Put `simplelocalize.yml` file in project root directory
36-
* Setup `projectType` property. [See list below](https://github.com/simplelocalize/simplelocalize-cli#-supported-libraries)
37-
* Run in terminal
16+
## Installation
3817

39-
```bash
40-
$ cd ~/MyProject #same place where the simplelocalize.yml is
41-
$ curl -s https://get.simplelocalize.io | bash
18+
```shell
19+
curl -s https://get.simplelocalize.io/install | bash
4220
```
4321

44-
Done! CLI will find i18n terms, and push them to [SimpleLocalize Platform](https://app.simplelocalize.io).
22+
## Usage
4523

46-
**Example** `simplelocalize.yml`
47-
48-
```yaml
49-
apiKey: <API_KEY>
50-
projectType: <SEE_BELOW>
24+
```properties
25+
simplelocalize-cli [COMMAND] --apiKey <PROJECT_API_KEY> rest of parameters...
5126
```
5227

53-
## 📖 Supported libraries
54-
55-
| Library | `projectType` value | Is supported? |
56-
| ------------- |-------------:|:----:|
57-
| [react-intl](https://github.com/yahoo/react-intl) | yahoo/react-intl | ✅
58-
| Standard Android internationalization | google/android | ✅ |
59-
| Standard iOS internationalization | apple/ios | [ ] |
60-
| [react-i18next](https://github.com/i18next/react-i18next) | i18next/i18next | ✅ |
61-
| [mde/ejs](https://github.com/mde/ejs) | mde/ejs | ✅ |
62-
| [ember-intl](https://github.com/ember-intl/ember-intl) | ember-intl/ember-intl | [ ] |
63-
| [jekyll-multiple-languages-plugin](https://github.com/Anthony-Gaudino/jekyll-multiple-languages-plugin) | Anthony-Gaudino/jekyll-multiple-languages-plugin | [ ] |
64-
| [dust-intl](https://github.com/yahoo/dust-intl) | yahoo/dust-intl | [ ] |
65-
| [handlebars-intl](https://github.com/yahoo/handlebars-intl) | yahoo/handlebars-intl | [ ] |
28+
## Available commands
6629

30+
Rememebr to [get API Key for your SimpleLocalize project](https://simplelocalize.io/docs/cli/get-started/) before your start.
6731

68-
## 🤖 Workflow automation
69-
70-
SimpleLocalize can be integrated with any CI/CD service, simply put bash script somewhere in your scripting environment to find and push translation keys:
71-
72-
```bash
73-
$ curl -s https://get.simplelocalize.io | bash
74-
```
75-
The best place to run SimpleLocalize script is **after successful build** because this will not result a wrong internationalisation keys caused by invalid syntax
76-
77-
## ⚙️ Available options
78-
SimpleLocalize CLI can be customized using `simplelocalize.yaml` file. See examples below.
79-
80-
### Ignoring keys
81-
82-
```yaml
83-
apiKey: <API_KEY>
84-
projectType: <PROJECT_TYPE>
85-
ignoredKeys:
86-
- "HEY"
87-
- "PLEASE"
88-
- "DO NOT IGNORE ME"
89-
- ":("
90-
```
91-
92-
### Custom search directory
93-
If you would like to search translation keys in some specific path you can achieve this by adding searchDir and path where the CLI should search keys.
94-
95-
```yaml
96-
apiKey: <API_KEY>
97-
projectType: <YOUR_PROJECT_TYPE>
98-
searchDir: /Users/jpomykala/Workspace/MyProject
99-
```
100-
Please pay attention to what you are putting in the `searchDir` property. This may cause high CPU and disc usage due to this will be looking for files to process and try to find translation keys.
101-
102-
### Configuration profiles
103-
If you would like to use simplelocalize.yml from custom location or with custom name like simplelocalize-dev.yml file. This can be easilly achieved by passing path as first argument.
104-
105-
```bash
106-
$ curl -s https://get.simplelocalize.io | bash -s /tmp/simplelocalize-dev.yml
107-
```
108-
109-
## 🤯 Problem with running CLI
110-
111-
In most cases you should use our regular script which is constantly optimized for everyone like below
112-
```bash
113-
$ curl -s https://get.simplelocalize.io | bash
114-
```
115-
If something is not working properly please [create an issue](https://github.com/simplelocalize/simplelocalize-cli/issues/new) and provide script output. In meantime, you can use one of 2 other options to run CLI.
116-
117-
118-
### Option 1: I have Java 11+ installed on my system, let me just use app in *.jar file.
119-
```bash
120-
$ curl -s https://get.simplelocalize.io/run-jar | bash
121-
```
122-
123-
### Option 2: I want to use *.jar file, but I don't have JDK installed.
124-
```bash
125-
$ curl -s https://get.simplelocalize.io/install-jdk-run-jar | bash
126-
```
32+
- `simplelocalize-cli extract` - learn more [how to extract translation keys from local files](https://simplelocalize.io/docs/cli/i18n-keys-extraction/)
33+
- `simplelocalize-cli upload` - learn more [how to upload translations or translation keys](https://simplelocalize.io/docs/cli/upload-translations/)
34+
- `simplelocalize-cli download` - learn more [how to download ready to use translation file](https://simplelocalize.io/docs/cli/download-translations/)
12735

12836

12937
## 👩‍⚖️ License

0 commit comments

Comments
 (0)