Skip to content

Commit 860aa17

Browse files
committed
Update README.md
1 parent 5c4ea2e commit 860aa17

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ffmpeg-cli
2-
[![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg?style=flat-square)](https://travis-ci.com/PotatoParser/ffmpeg-cli) [![Node v10](https://img.shields.io/badge/Node-v10-brightgreen.svg?style=flat-square)](https://nodejs.org/en/download/) [![Node v11](https://img.shields.io/badge/Node-v11-brightgreen.svg?style=flat-square)](https://nodejs.org/en/download/)
2+
[![Build Status](https://img.shields.io/badge/build-passing-brightgreen.svg?style=flat-square)](https://travis-ci.com/PotatoParser/ffmpeg-cli) [![Node LTS](https://img.shields.io/badge/Node-LTS-brightgreen.svg?style=flat-square)](https://nodejs.org/dist/latest-v10.x/) [![Node v10](https://img.shields.io/badge/Node-v10-brightgreen.svg?style=flat-square)](https://nodejs.org/en/download/)
33

44
A simple way of implementing FFmpeg regardless of OS
55
```javascript
@@ -8,15 +8,15 @@ ffmpeg.run("-version");
88
console.log(ffmpeg.runSync("-version"));
99
```
1010
## Hassle Free!
11-
No need to install other programs as ffmpeg-cli will download and unzip necessary binaries for your OS!
11+
No need to install other programs as ffmpeg-cli will download and extract necessary binaries for your OS!
1212

1313
## Supported OS
1414
+ MacOS ~ 64 bit
1515
+ Linux ~ 32/64 bit
1616
+ Windows ~ 32/64 bit
1717

1818
## FFmpeg Path
19-
Returns the path of ffmpeg executable
19+
Returns the path of FFmpeg executable
2020
```javascript
2121
ffmpeg.path;
2222
// Ex: C:\Users\PotatoParser\Desktop\NodeJS\ffmpeg-cli\ffmpeg\win32x64\bin\ffmpeg.exe
@@ -28,7 +28,7 @@ ffmpeg.runSync(commands);
2828
// Ex: ffmpeg.runSync(`-i input.jpg -vf scale=320:240 output.png`);
2929
```
3030
## Asynchronous Commands
31-
Returns a promise
31+
Returns a <Promise>
3232
```javascript
3333
ffmpeg.run(commands);
3434
ffmpeg.run(commands).catch((error)=>{...}); // Catch errors
@@ -39,6 +39,7 @@ ffmpeg.run(commands).then((result)=>{...}).catch((error)=>{...}); // Catches whe
3939
## FFmpeg Force Re-Download
4040
**Run to redownload (synchronously) ffmpeg files**
4141
Returns true if download is successful
42+
4243
```javascript
4344
ffmpeg.forceDownload();
4445
```

0 commit comments

Comments
 (0)