diff --git a/README.md b/README.md index 3710099..32a8bfb 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/example/README.md b/example/README.md index 264c551..a30a137 100644 --- a/example/README.md +++ b/example/README.md @@ -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.