Skip to content

Commit 4c0d554

Browse files
authored
docs: Improve docs (#1518)
# Description - how to add main branch as git dependency - link screenshots to example code - getting started with the most common use case
1 parent 5d164d1 commit 4c0d554

2 files changed

Lines changed: 43 additions & 2 deletions

File tree

contributing.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,42 @@ You should only need to run this command once.
3434

3535
> You do not need to run `flutter pub get` once bootstrap has been completed.
3636
37+
### Current Development
38+
39+
If you want to use the most recent changes in your own project add following dependencies to your `pubspec.yaml` or `pubspec_overrrides.yaml`:
40+
41+
```yaml
42+
dependency_overrides:
43+
audioplayers:
44+
git:
45+
url: https://github.com/bluefireteam/audioplayers.git
46+
path: 'packages/audioplayers'
47+
audioplayers_platform_interface:
48+
git:
49+
url: https://github.com/bluefireteam/audioplayers.git
50+
path: 'packages/audioplayers_platform_interface'
51+
audioplayers_web:
52+
git:
53+
url: https://github.com/bluefireteam/audioplayers.git
54+
path: 'packages/audioplayers_web'
55+
audioplayers_linux:
56+
git:
57+
url: https://github.com/bluefireteam/audioplayers.git
58+
path: 'packages/audioplayers_linux'
59+
audioplayers_android:
60+
git:
61+
url: https://github.com/bluefireteam/audioplayers.git
62+
path: 'packages/audioplayers_android'
63+
audioplayers_darwin:
64+
git:
65+
url: https://github.com/bluefireteam/audioplayers.git
66+
path: 'packages/audioplayers_darwin'
67+
audioplayers_windows:
68+
git:
69+
url: https://github.com/bluefireteam/audioplayers.git
70+
path: 'packages/audioplayers_windows'
71+
```
72+
3773
## Old Issues/PRs
3874
3975
We have many existing open issues and a few open PRs that were created before this doc was created. We will try to respect their ignorance of this file's existence by doing our best effort to answer/address/fix/merge them as we normally would up to this point (i.e. as time permits).

packages/audioplayers/README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
---
1818

19-
<img src="https://raw.githubusercontent.com/bluefireteam/audioplayers/main/images/screenshot_src.png" width="25%"/><img src="https://raw.githubusercontent.com/bluefireteam/audioplayers/main/images/screenshot_ctrl.png" width="25%"/><img src="https://raw.githubusercontent.com/bluefireteam/audioplayers/main/images/screenshot_stream.png" width="25%"/><img src="https://raw.githubusercontent.com/bluefireteam/audioplayers/main/images/screenshot_ctx.png" width="25%"/>
19+
<a title="Sources" href="https://github.com/bluefireteam/audioplayers/blob/main/packages/audioplayers/example/lib/tabs/sources.dart"><img src="https://raw.githubusercontent.com/bluefireteam/audioplayers/main/images/screenshot_src.png" width="25%"/></a><a title="Controls" href="https://github.com/bluefireteam/audioplayers/blob/main/packages/audioplayers/example/lib/tabs/controls.dart"><img src="https://raw.githubusercontent.com/bluefireteam/audioplayers/main/images/screenshot_ctrl.png" width="25%"/></a><a title="Streams" href="https://github.com/bluefireteam/audioplayers/blob/main/packages/audioplayers/example/lib/tabs/streams.dart"><img src="https://raw.githubusercontent.com/bluefireteam/audioplayers/main/images/screenshot_stream.png" width="25%"/></a><a title="Audio Context" href="https://github.com/bluefireteam/audioplayers/blob/main/packages/audioplayers/example/lib/tabs/audio_context.dart"><img src="https://raw.githubusercontent.com/bluefireteam/audioplayers/main/images/screenshot_ctx.png" width="25%"/></a>
2020

2121
**Note**: all the docs are kept up to date to reflect the content of the current newest release. If you are looking for older information and guidance, please checkout the [tag](https://github.com/bluefireteam/audioplayers/tags) related to the version that you are looking for.
2222

@@ -25,7 +25,12 @@ If you are interest in migrating major versions, please check the [changelog](CH
2525

2626
## Getting Started
2727

28-
We tried to make audioplayers as simple to use as possible.
28+
We tried to make audioplayers as simple to use as possible:
29+
30+
```dart
31+
final player = AudioPlayer();
32+
await player.play(UrlSource('https://example.com/my-audio.wav'));
33+
```
2934

3035
Please follow our [Getting Started tutorial](https://github.com/bluefireteam/audioplayers/blob/main/getting_started.md) for all high-level information you need to know.
3136

0 commit comments

Comments
 (0)