Merge remote-tracking branch 'origin/master'

Author: jonas-jasas

README.md

@@ -1,12 +1,8 @@
 # ConvertAPI CLI Client
 
-## Convert your files with our command line file conversion utility
+## Convert your files with our command-line file conversion utility
 
-The ConvertAPI helps converting various file formats.
-Creating PDF and Images from various sources like Word, Excel, Powerpoint, images, web pages or raw HTML codes.
-Merge, Encrypt, Split, Repair and Decrypt PDF files.
-And many others files manipulations.
-In just few minutes you can integrate it into your application or shell script and use it easily.
+ConvertAPI helps in converting various file formats. Creating PDF and Images from various sources like Word, Excel, Powerpoint, images, web pages or raw HTML codes. Merge, Encrypt, Split, Repair and Decrypt PDF files and many other file manipulations. You can integrate it into your application in just a few minutes and use it easily.
 
 The ConvertAPI CLI makes it easier to use the Convert API from your shell without having to build your own HTTP calls.
 You can get your free secret at https://www.convertapi.com/a
@@ -15,12 +11,12 @@ You can get your free secret at https://www.convertapi.com/a
 
 Download compressed CLI executable
 
-* Linux: [convertapi_lin.zip](http://github)
-* Linux ARM64: [convertapi_lin_arm.zip](http://github)
-* Darwin (MacOS): [convertapi_mac.zip](http://github)
-* Windows: [convertapi_win.zip](http://github)
+* Linux: [convertapi_lin.zip](https://github.com/ConvertAPI/convertapi-cli/releases/download/v1/convertapi_lin.zip)
+* Linux ARM64: [convertapi_lin_arm.zip](https://github.com/ConvertAPI/convertapi-cli/releases/download/v1/convertapi_lin_arm.zip)
+* Darwin (MacOS): [convertapi_mac.zip](https://github.com/ConvertAPI/convertapi-cli/releases/download/v1/convertapi_mac.zip)
+* Windows: [convertapi_win.zip](https://github.com/ConvertAPI/convertapi-cli/releases/download/v1/convertapi_win.zip)
 
-(this utility also can be built from source code for many other CPU and OS)
+(this utility can also be built from source code for many other CPU and OS)
 
 Unzip executable 
 
@@ -29,7 +25,7 @@ unzip convertapi_*.zip
 ```
 
 And you are done.
-Optionally you can move executable file to more appropriate place and make utility accessible for all local users. On Linux would be:   
+Optionally you can move the executable file to a more appropriate place and make utility accessible for all local users. On Linux it would be:   
 
 ```shell
 sudo mv convertapi /usr/local/bin
@@ -39,16 +35,16 @@ sudo mv convertapi /usr/local/bin
 
 ### Before you start
 
-In order to use this CLI utility you must create your free trial account on https://www.convertapi.com site.  
-After sign up process you will get your secret at https://www.convertapi.com/a .
-Secret will be used in every CLI utility run.
+In order to use this CLI utility, you must create your free trial account on https://www.convertapi.com site.  
+After the sign-up process, you will get your secret at https://www.convertapi.com/a .
+The secret will be used in every CLI utility run.
 
-### Most basic file conversion
+### Basic file conversion
 
-Before we go in to details, short usage example how to convert DOCX file to PDF.
+Before we go into detail, a short usage example of how to convert DOCX file to PDF.
 
 ```shell
-convertapi --iformat=docx --oformat=pdf --params="file:@/path/to/test.docx" --out="@/path/to/resultdir" --secret=<YOUR_SECRET_HERE>
+convertapi --iformat=docx --oformat=pdf --params="file:@/path/to/test.docx" --out="@/path/to/resultdir" --secret=your-api-secret
 ```
 
 ### Arguments documentation 
@@ -87,12 +83,12 @@ Comma `,` inside the parameter value must be escaped with `\,`.
 ##### File parameter
 
 Special case is file parameter.
-Value can have prefix and can be provided as an array with `;` semicolon separator. 
-Prefix can be one of those:
+Value can have a prefix and can be provided as an array with the `;` semicolon separator. 
+The prefix can be one of those:
 
 ###### no prefix
 
-No prefix means that value is http or https scheme URL to file.
+No prefix means that the value is http or https scheme URL to a file.
 _Example:_ 
 
 ```shell
@@ -101,7 +97,7 @@ _Example:_
 
 ###### @
 
-Parameter values starting from `@` are treated as paths to local files or directories.
+Parameter values starting with `@` are treated as paths to the local files or directories.
 _Example:_ 
 
 ```shell
@@ -110,8 +106,8 @@ _Example:_
 
 ###### <
 
-Parameters with `<` values are substituted with data taken from `STDIN`.
-As raw value can only be URL so in this case data received from `STDIN` should be URL or URL array separated by `\n`
+Parameters with `<` values are substituted with the data taken from `STDIN`.
+As a raw value can only be the URL then, in this case, the data received from `STDIN` should be URL or URL array separated by `\n`
 _Example:_ 
 
 ```shell
@@ -120,9 +116,9 @@ _Example:_
 
 ###### @<
 
-Parameters with `@<` values are substituted with data taken from `STDIN`.
-Data received from `STDIN` should be local path to file or directory. 
-Also can be an array of paths separated by `\n`.
+Parameters with `@<` values are substituted with the data taken from `STDIN`.
+Data received from `STDIN` should be a local path to the file or directory. 
+It can also be an array of paths separated by `\n`.
 _Example:_ 
 
 ```shell
@@ -131,7 +127,7 @@ _Example:_
 
 ###### <<
 
-Parameters with `<<` values are substituted with data taken from `STDIN`.
+Parameters with `<<` values are substituted with the data taken from `STDIN`.
 Data received from `STDIN` should be file content. 
 _Example:_ 
 
@@ -141,7 +137,7 @@ _Example:_
 
 ##### Array parameter
 
-If parameter name is suffixed with `[]` parameter gets treated as an array parameter.
+If a parameter name is suffixed with `[]`, the parameter is treated as an array parameter.
 Mainly array parameters are used when one conversion needs to accept multiple files (e.g. pdf merge or zip compression).
 
 ```shell
@@ -150,17 +146,17 @@ Mainly array parameters are used when one conversion needs to accept multiple fi
 
 #### --out
 
-Argument defines how conversion result should be outputted.
+The argument defines how conversion result should be outputted.
 Values can be one of those:
 
 ##### url
 
-This is default output method. It prints to `STDOUT` URL or array of URLs that point to converted files.
+This is the default output method. It prints to `STDOUT` URL or array of URLs that point to the converted files.
 This method should be used for conversion chaining.
 
 ##### @
 
-Value prefixed with `@` is treated as local file or directory path where converted file will be stored.   
+Value prefixed with `@` is treated as a local file or directory path where the converted file will be stored. 
 _Example:_ 
 
 ```shell
@@ -173,8 +169,8 @@ or
 
 ##### stdout
 
-Conversion result will be outputted to `STDOUT`.
-If result consists of multiple files, second and other files will be outputted to file descriptors starting from 3.
+The Conversion result will be outputted to `STDOUT`.
+If the result contains multiple files, second and the following files will be outputted to the file descriptors starting from 3.
 
 ```shell
 --out="stdout"
@@ -191,57 +187,57 @@ Outputs CLI utility version information and exits.
 
 #### --help
 
-Displays short usage information.
+Displays a short usage information.
 
 
 ### Examples
 
-Convert local DOCX file to PDF A3 page size saving result to `/path/to/resultdir`
+Convert a local DOCX file to PDF A3 page size saving the result to `/path/to/resultdir`
 ```shell
-convertapi --iformat=docx --oformat=pdf --params="file:@/path/to/test.docx, pagesize:a3" --out="@/path/to/resultdir" --secret=<YOUR_SECRET_HERE>
+convertapi --iformat=docx --oformat=pdf --params="file:@/path/to/test.docx, pagesize:a3" --out="@/path/to/resultdir" --secret=your-api-secret
 ```
 
-Merge all PDF files that are in `/path/to/dir` directory and save it locally
+Merge all PDF files that are located in `/path/to/dir` directory and save it locally
 ```shell
-convertapi --iformat=pdf --oformat=merge --params="files[]:@/path/to/dir" --out="@/path/to/resultdir" --secret=<YOUR_SECRET_HERE>
+convertapi --iformat=pdf --oformat=merge --params="files[]:@/path/to/dir" --out="@/path/to/resultdir" --secret=your-api-secret
 ```
 
-Convert remote PPTX file to PDF saving result to `/path/to/result.pdf`
+Convert remote PPTX file to PDF saving the result to `/path/to/result.pdf`
 ```shell
-convertapi --iformat=pptx --oformat=pdf --params="file:https://example.com/myfile.pptx" --out="@/path/to/result.pdf" --secret=<YOUR_SECRET_HERE>
+convertapi --iformat=pptx --oformat=pdf --params="file:https://example.com/myfile.pptx" --out="@/path/to/result.pdf" --secret=your-api-secret
 ```
 
-Convert from DOCX to JPG and ZIP result JPG files
+Convert from DOCX to JPG and ZIP the result JPG files into a single archive
 ```shell
-convertapi --iformat=docx --oformat=jpg --params="file:@/path/to/test.docx" --secret=<YOUR_SECRET_HERE> \
-    | convertapi --iformat=jpg --oformat=zip --params="files[]:<" --out="@/path/to/result.zip" --secret=<YOUR_SECRET_HERE>
+convertapi --iformat=docx --oformat=jpg --params="file:@/path/to/test.docx" --secret=your-api-secret \
+    | convertapi --iformat=jpg --oformat=zip --params="files[]:<" --out="@/path/to/result.zip" --secret=your-api-secret
 ```
 
-Convert DOCX to PDF and save result in remote server over SSH
+Convert DOCX to PDF and save the result on a remote server over SSH
 ```shell
-convertapi --iformat=docx --oformat=pdf --params="file:@/path/to/test.docx" --out=stdout --secret=<YOUR_SECRET_HERE> \
+convertapi --iformat=docx --oformat=pdf --params="file:@/path/to/test.docx" --out=stdout --secret=your-api-secret \
     | ssh user@myserver "cat >/tmp/my.pdf"
 ```
 
-Get PDF file from remote server, convert it to JPG and save result locally
+Get the PDF file from a remote server, convert it to JPG and save the result locally
 ```shell
 ssh user@server "cat /tmp/my.pdf" \
-    | convertapi --iformat=pdf --oformat=jpg --params="file:<<" --out=@/path/to/resultdir --secret=<YOUR_SECRET_HERE>
+    | convertapi --iformat=pdf --oformat=jpg --params="file:<<" --out=@/path/to/resultdir --secret=your-api-secret
 ```
 
-Do PDF->JPG and DOCX->JPG conversions in parallel and ZIP result JPG files
+Do PDF->JPG and DOCX->JPG conversions in parallel and ZIP the converted JPG files
 ```shell
 ( \
-    convertapi --iformat=pdf --oformat=jpg --params="file:/path/to/dir" --secret=<YOUR_SECRET_HERE> \
-    & convertapi --iformat=docx --oformat=jpg --params="file:@/path/to/dir" --secret=<YOUR_SECRET_HERE> \
-) | convertapi --iformat=jpg --oformat=zip --params="files[]:<" --out=@/path/to/resultdir  --secret=<YOUR_SECRET_HERE>
+    convertapi --iformat=pdf --oformat=jpg --params="file:/path/to/dir" --secret=your-api-secret \
+    & convertapi --iformat=docx --oformat=jpg --params="file:@/path/to/dir" --secret=your-api-secret \
+) | convertapi --iformat=jpg --oformat=zip --params="files[]:<" --out=@/path/to/resultdir  --secret=your-api-secret
 ```
 
-Merge PDFs files from various locations: remote SSH server, local file, local directory, remote HTTP server.
-Save result file to remote SSH server. All this done without writing to disk. 
+Merge PDFs files from various locations: a remote SSH server, local file, local directory, and a remote HTTP server.
+Save the result file on a remote SSH server. All of this is done without writing to disk. 
 ```shell
 ssh user@server1 "cat /tmp/my.pdf" \
-    | convertapi --iformat=pdf --oformat=merge --params="files[]:<<;@/path/to/test.pdf;@/path/to/dir;https://example.com/my.pdf" --out=stdout --secret=<YOUR_SECRET_HERE> \
+    | convertapi --iformat=pdf --oformat=merge --params="files[]:<<;@/path/to/test.pdf;@/path/to/dir;https://example.com/my.pdf" --out=stdout --secret=your-api-secret \
     | ssh user@myserver2 "cat >/tmp/my.pdf"
 ```
 
@@ -250,4 +246,4 @@ Please leave all comments, bugs, requests, and issues on the Issues page. We'll
 
 ### License
 The ConvertAPI CLI is licensed under the [MIT](http://www.opensource.org/licenses/mit-license.php "Read more about the MIT license form") license.
-Refer to the [LICENSE](https://github.com/ConvertAPI/convertapi-cli/blob/master/LICENSE) file for more information.
+Refer to the [LICENSE](https://raw.githubusercontent.com/ConvertAPI/convertapi-cli/master/LICENSE.txt) file for more information.