Skip to content

Commit 5b4245e

Browse files
Fixed readme description.
1 parent 91a67b0 commit 5b4245e

File tree

1 file changed

+20
-26
lines changed

1 file changed

+20
-26
lines changed

README.md

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ You can get your free secret at https://www.convertapi.com/a
1111

1212
Download compressed CLI executable
1313

14-
* Linux: [convertApi-cli-linux-x64.zip](https://github.com/ConvertAPI/convertapi-cli/releases/latest/download/convertApi-cli-linux-x64.zip)
15-
* Linux ARM64: [convertApi-cli-linux-arm64.zip](https://github.com/ConvertAPI/convertapi-cli/releases/latest/download/convertApi-cli-linux-arm64.zip)
16-
* MacOS (Intel x64): [convertApi-cli-osx-x64.zip](https://github.com/ConvertAPI/convertapi-cli/releases/latest/download/convertApi-cli-osx-x64.zip)
17-
* MacOS (Apple Silicon arm64): [convertApi-cli-osx-arm64.zip](https://github.com/ConvertAPI/convertapi-cli/releases/latest/download/convertApi-cli-osx-arm64.zip)
18-
* Windows: [convertApi-cli-win-x64.zip](https://github.com/ConvertAPI/convertapi-cli/releases/latest/download/convertApi-cli-win-x64.zip)
14+
* Linux: [convertapi-cli-linux-x64.zip](https://github.com/ConvertAPI/convertapi-cli/releases/latest/download/convertapi-cli-linux-x64.zip)
15+
* Linux ARM64: [convertapi-cli-linux-arm64.zip](https://github.com/ConvertAPI/convertapi-cli/releases/latest/download/convertapi-cli-linux-arm64.zip)
16+
* MacOS (Intel x64): [convertapi-cli-osx-x64.zip](https://github.com/ConvertAPI/convertapi-cli/releases/latest/download/convertapi-cli-osx-x64.zip)
17+
* MacOS (Apple Silicon arm64): [convertapi-cli-osx-arm64.zip](https://github.com/ConvertAPI/convertapi-cli/releases/latest/download/convertapi-cli-osx-arm64.zip)
18+
* Windows: [convertapi-cli-win-x64.zip](https://github.com/ConvertAPI/convertapi-cli/releases/latest/download/convertapi-cli-win-x64.zip)
1919

2020
(this utility can also be built from source code for many other CPU and OS)
2121

@@ -37,7 +37,7 @@ sudo mv convertapi /usr/local/bin
3737
### Before you start
3838

3939
In order to use this CLI utility, you must create your free trial account on https://www.convertapi.com site.
40-
After the sign-up process, you will get your secret at https://www.convertapi.com/a .
40+
After the sign-up process, you will get your secret at https://www.convertapi.com/a/secret.
4141
The secret will be used in every CLI utility run.
4242

4343
### Basic file conversion
@@ -58,54 +58,48 @@ convertapi-cli.exe
5858

5959
#### api-token (Authentication)
6060
Any of these authentication mechanisms can be used as `api-token`:
61-
- ConvertAPI user**secret**: https://www.convertapi.com/a
62-
- **Access token**: [ConvertAPI dashboard](https://www.convertapi.com/a/access-tokens).
63-
- **JWT token**: [ConvertAPI dashboard](https://www.convertapi.com/a/jwt-tokens).
61+
- ConvertAPI user **[Secret](https://www.convertapi.com/a/secret)**
62+
- ConvertAPI **[Access token](https://www.convertapi.com/a/access-tokens)**
6463

6564
_Example:_
6665

6766
```shell
6867
api_token
6968
```
7069

71-
#### output-directory
70+
### output-directory
7271
Directory where converted file / files needs to be saved in your system.
7372
_Example:_
7473

7574
```shell
7675
<directory-in-your-file-system>
7776
```
7877

79-
##### input-files parameter
78+
### input-files parameter
8079
The full file path in your file system. If the conversion supports multiple input files, separate their full paths with spaces (' ').
8180
```shell
8281
<full-path1> <full-path2> <full-path3>
8382
```
8483

8584

86-
##### from-format
85+
### from-format
8786
Find specific formats from all conversions here: https://www.convertapi.com/api. When you open a conversion, the **From** (Source) and **To** (Destination) formats are visible in the browser's URL and in the API Request panel, which displays the HTTP POST request URL.
8887
_Example:_
89-
- Docx to Html conversion: https://www.convertapi.com/a/api/docx-to-html. **From-format** is: `docx`.
90-
- Watermark PDF conversion: https://www.convertapi.com/a/api/pdf-to-watermark. **From-format** is: `pdf`.
91-
- Images to Join conversion: https://www.convertapi.com/a/api/images-to-join. **From-format** is: `images`.
88+
- Docx to Html conversion: https://www.convertapi.com/docx-to-html. **From-format** is: `docx`.
89+
- Watermark PDF conversion: https://www.convertapi.com/pdf-to-watermark. **From-format** is: `pdf`.
90+
- Images to Join conversion: https://www.convertapi.com/images-to-join. **From-format** is: `images`.
9291

93-
##### to-format
92+
### to-format
9493
Find specific formats from all conversions here: https://www.convertapi.com/api. When you open a conversion, the **From** (Source) and **To** (Destination) formats are visible in the browser's URL and in the API Request panel, which displays the HTTP POST request URL.
9594

9695
_Example:_
97-
- Docx to Html conversion: https://www.convertapi.com/a/api/docx-to-html. **To-format** is: `html`.
98-
- Watermark PDF conversion: https://www.convertapi.com/a/api/pdf-to-watermark. **To-format** is: `watermark`.
99-
- Images to Join conversion: https://www.convertapi.com/a/api/images-to-join. **To-format** is: `join`.
96+
- Docx to Html conversion: https://www.convertapi.com/docx-to-html. **To-format** is: `html`.
97+
- Watermark PDF conversion: https://www.convertapi.com/pdf-to-watermark. **To-format** is: `watermark`.
98+
- Images to Join conversion: https://www.convertapi.com/images-to-join. **To-format** is: `join`.
10099

101-
##### Parameters
102-
All parameters can be found on a specific conversion. Parameters are separated with spaces (' ').
100+
### Parameters
101+
All parameters for a specific conversion can be found on its dedicated page. To view them, navigate to the [All conversions list](https://www.convertapi.com/api), find the desired conversion, and click on it. On the conversion's page, you will see all available parameters.
103102

104-
_Example:_
105-
For example, we are doing PDF to JPG conversion: https://www.convertapi.com/a/api/pdf-to-jpg and want to set Pdf password, result file name and result image resolution.
106-
```shell
107-
password=1234 filename=new-wonderful-name ImageResolution=300
108-
```
109103

110104
## Examples
111105

0 commit comments

Comments
 (0)