Skip to content

Commit

Permalink
update project readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tanersener committed Oct 6, 2021
1 parent 3bc1844 commit 6bb4fc3
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# FFmpegKit ![GitHub release](https://img.shields.io/badge/release-v4.5-blue.svg) ![Maven Central](https://img.shields.io/maven-central/v/com.arthenica/ffmpeg-kit-min) ![CocoaPods](https://img.shields.io/cocoapods/v/ffmpeg-kit-ios-min) ![pub](https://img.shields.io/pub/v/ffmpeg_kit_flutter.svg) ![npm](https://img.shields.io/npm/v/ffmpeg-kit-react-native.svg)

<img src="https://github.com/tanersener/ffmpeg-kit/blob/main/docs/assets/ffmpeg-kit-icon-v9.png" width="240">

`FFmpegKit` is a collection of tools to use `FFmpeg` in `Android`, `iOS`, `macOS`, `tvOS`, `Flutter` and `React Native` applications.

It includes scripts to build `FFmpeg` libraries natively, a wrapper library to run `FFmpeg`/`FFprobe` commands in
It includes scripts to build `FFmpeg` native libraries, a wrapper library to run `FFmpeg`/`FFprobe` commands in
applications and 8 prebuilt binary packages available at [Github](https://github.com/tanersener/ffmpeg-kit/releases),
[Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org), [pub](https://pub.dev) and [npm](https://www.npmjs.com).

<img src="https://github.com/tanersener/ffmpeg-kit/blob/development/docs/assets/ffmpeg-kit-icon-v9.png" width="240">

### 1. Features
- Scripts to build FFmpeg libraries natively
- Scripts to build FFmpeg native libraries
- `FFmpegKit` wrapper library to run `FFmpeg`/`FFprobe` commands in applications
- Supports native platforms: Android, iOS, macOS and tvOS
- Supports hybrid platforms: Flutter, React Native
Expand Down Expand Up @@ -41,7 +41,8 @@ See [React Native](https://github.com/tanersener/ffmpeg-kit/tree/main/react-nati

Use `android.sh`, `ios.sh`, `macos.sh` and `tvos.sh` to build `FFmpegKit` for each native platform.

All scripts support additional options to enable optional libraries and disable platform architectures.
All scripts support additional options to enable optional libraries and disable platform architectures. See
[Building](https://github.com/tanersener/ffmpeg-kit/wiki/Building) wiki page for the details.

### 7. FFmpegKit Library

Expand Down
11 changes: 6 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# FFmpegKit

<img src="https://github.com/tanersener/ffmpeg-kit/raw/main/docs/assets/ffmpeg-kit-icon-v9.png" width="180">

`FFmpegKit` is a collection of tools to use `FFmpeg` in `Android`, `iOS`, `macOS`, `tvOS`, `Flutter` and `React Native` applications.

It includes scripts to build `FFmpeg` libraries natively, a wrapper library to run `FFmpeg`/`FFprobe` commands in
It includes scripts to build `FFmpeg` native libraries, a wrapper library to run `FFmpeg`/`FFprobe` commands in
applications and 8 prebuilt binary packages available at [Github](https://github.com/tanersener/ffmpeg-kit/releases),
[Maven Central](https://search.maven.org), [CocoaPods](https://cocoapods.org), [pub](https://pub.dev) and [npm](https://www.npmjs.com).

<img src="https://github.com/tanersener/ffmpeg-kit/raw/main/docs/assets/ffmpeg-kit-icon-v9.png" width="180">

### 1. Features
- Scripts to build FFmpeg libraries
- Scripts to build FFmpeg native libraries
- `FFmpegKit` wrapper library to run `FFmpeg`/`FFprobe` commands in applications
- Supports native platforms: Android, iOS, macOS and tvOS
- Supports hybrid platforms: Flutter, React Native
Expand Down Expand Up @@ -41,7 +41,8 @@ See [React Native](https://github.com/tanersener/ffmpeg-kit/tree/main/react-nati

Use `android.sh`, `ios.sh`, `macos.sh` and `tvos.sh` to build `FFmpegKit` for each native platform.

All scripts support additional options to enable optional libraries and disable platform architectures.
All scripts support additional options to enable optional libraries and disable platform architectures. See
[Building](https://github.com/tanersener/ffmpeg-kit/wiki/Building) wiki page for the details.

### 7. FFmpegKit Library

Expand Down
2 changes: 1 addition & 1 deletion flutter/flutter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ In order to install the `LTS` variant, append `-LTS` to the version you have for

```yaml
dependencies:
ffmpeg_kit_flutter: ^4.5.0-LTS
ffmpeg_kit_flutter: 4.5.0-LTS
```

#### 2.4 LTS Releases
Expand Down

0 comments on commit 6bb4fc3

Please sign in to comment.