Skip to content

Commit 7339ab2

Browse files
authored
Update README.md
moved user docs to wiki, left developer docs in readme
1 parent f873fd8 commit 7339ab2

File tree

1 file changed

+3
-52
lines changed

1 file changed

+3
-52
lines changed

README.md

Lines changed: 3 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,9 @@
1-
# Smartling
1+
# User Documentation
22

3-
A CLI interface for the [Smartling Translation Management Platform's APIs](https://help.smartling.com/v1.0/reference) in Go.
4-
Currently alpha release, commands and parameters are subject to change.
5-
6-
# Installation
7-
8-
### Windows
9-
```
10-
curl --output smartling-cli.exe https://smartling-connectors-releases.s3.amazonaws.com/cli/smartling.windows.exe
11-
```
12-
13-
### Mac OS
14-
```
15-
curl --output smartling-cli https://smartling-connectors-releases.s3.amazonaws.com/cli/smartling.darwin \
16-
&& sudo chmod +x smartling-cli \
17-
&& sudo mv smartling-cli /usr/local/bin/
18-
```
19-
20-
### Linux
21-
```
22-
curl --output smartling-cli https://smartling-connectors-releases.s3.amazonaws.com/cli/smartling.linux \
23-
&& sudo chmod +x smartling-cli \
24-
&& sudo mv smartling-cli /usr/local/bin/
25-
```
26-
27-
### From sources
28-
```
29-
go get github.com/Smartling/smartling-cli
30-
```
31-
32-
# Initial configuration
33-
34-
First of all, you need to create config file with authentication parameters
35-
for your project. To ease process, there is `init` command:
36-
37-
```
38-
smartling-cli init
39-
```
40-
41-
# Example usages
42-
43-
Display all target project locales along with their description.
44-
```
45-
smartling-cli projects locales
46-
```
47-
48-
Upload file as is for translation with automatic file type detection.
49-
```
50-
smartling-cli files push my-file.txt
51-
```
52-
53-
Find more [example usages there](examples.md).
3+
See the [Wiki](https://github.com/Smartling/smartling-cli/wiki) page for this repository.
544

555
# Development
6+
For developers interested in modifying the tool.
567

578
## Building package
589

0 commit comments

Comments
 (0)