Skip to content

Commit

Permalink
doc - improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Mael Le Goff committed Mar 11, 2022
1 parent fd1f5cf commit c6a5d4b
Showing 1 changed file with 9 additions and 31 deletions.
40 changes: 9 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,17 @@
# video_editor
# Flutter video editor

<br>
[![Platform](https://img.shields.io/badge/Platform-Flutter-yellow.svg)](https://flutter.io)
[![Pub](https://img.shields.io/pub/v/video_editor.svg?logo=flutter&color=blue&style=flat-square)](https://pub.dev/packages/video_editor)

## My other APIs
A video editor that allows to edit (trim, crop, rotate and scale) and choose a cover with a very flexible UI design.
The changes are then exported with `ffmpeg`.

### My other APIs

- [Scroll Navigation](https://pub.dev/packages/scroll_navigation)
- [Video Viewer](https://pub.dev/packages/video_viewer)
- [Helpers](https://pub.dev/packages/helpers)

<br>

## Features

- Super flexible UI Design.
- Support actions:
- Crop
- Trim
- Scale
- Rotate
- Cover selection

<br><br>

## **Installation** (More info on [Flutter ffmepeg kit](https://github.com/tanersener/ffmpeg-kit/tree/main/flutter/flutter))
Following steps will help you add this library as a dependency in your flutter project.

Expand All @@ -32,7 +22,7 @@ dependencies:
video_editor: ^1.2.3
```

- Run the following command to get packages:
- Run the following command to install the package:

```bash
$ flutter packages get
Expand All @@ -43,22 +33,13 @@ $ flutter packages get
```dart
import 'package:video_editor/video_editor.dart';
```
<br><br>

## **Example** (The UI Design is fully customizable on the [example](https://pub.dev/packages/video_editor/example))

- Dependencies used:
- [Helpers](https://pub.dev/packages/helpers)
- [Image Picker](https://pub.dev/packages/image_picker)

<br>
## **Screenshots** (The UI Design is fully customizable on the [example](https://pub.dev/packages/video_editor/example))

| Crop Video | Rotate Video |
| ----------------------------------- | ------------------------------------- |
| ![](./assets/readme/crop_video.gif) | ![](./assets/readme/rotate_video.gif) |

<br>

| Trim Video | Export Video |
| ----------------------------------- | ------------------------------------- |
| ![](./assets/readme/trim_video.gif) | ![](./assets/readme/export_video.gif) |
Expand All @@ -71,9 +52,6 @@ import 'package:video_editor/video_editor.dart';
| ------------------------------------- | ------------------------------------- |
| ![](./assets/readme/cover_viewer.gif) | ![](./assets/readme/export_cover.gif) |


<br><br>

## Main Contributors

<table>
Expand Down

0 comments on commit c6a5d4b

Please sign in to comment.