Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
suragch committed Dec 30, 2020
1 parent 5cf015a commit 088a6ff
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 13 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ A progress bar widget to show or change the position of an audio or video stream

![](https://github.com/suragch/audio_video_progress_bar/blob/master/supplemental/progress_bar_demo.gif)

***Note**: This package does not play audio or video itself. It's just a widget you can use to show the progress of your audio or video player. This widget is easier to connect to a media player than the Flutter Slider widget is. It also supports showing the buffered status for streamed media.*

## Example

Add the `ProgressBar` widget to your UI. A static example would look like this:
Expand Down
15 changes: 2 additions & 13 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
# audio_video_progress_bar_example

Demonstrates how to use the audio_video_progress_bar plugin.
Demonstrates how to use the audio_video_progress_bar package.

## Getting Started

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

- [Lab: Write your first Flutter app](https://flutter.dev/docs/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://flutter.dev/docs/cookbook)

For help getting started with Flutter, view our
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
The audio player in this example uses the [just_audio](https://pub.dev/packages/just_audio) plugin.

0 comments on commit 088a6ff

Please sign in to comment.