Skip to content

Commit bc1ecdc

Browse files
authored
chore: release audio_player_service v.1.0.0
2 parents cb06b63 + 1628e15 commit bc1ecdc

File tree

6 files changed

+66
-4
lines changed

6 files changed

+66
-4
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## 1.0.0
2+
3+
* feat: initial release of `audio_player_service` 🎉

CONTRIBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing to Audio Player Service
2+
3+
First off, thanks for taking the time to contribute!
4+
5+
The following is a set of guidelines for contributing to the library and related packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
6+
7+
## Proposing a Change
8+
9+
We recommend filing an issue if you intend to change the public API or make any non-trivial changes to the implementation. It lets us reach an agreement on your proposal before you put significant effort into it.
10+
11+
If you’re only fixing a bug, it’s fine to submit a pull request right away, but we still recommend filing an issue detailing what you’re fixing. It is helpful if we don’t accept that specific fix but want to keep track of the issue.
12+
13+
## Creating a Pull Request
14+
15+
Before creating a pull request please:
16+
17+
1. Fork the repository and create your branch from `main`.
18+
1. Install all dependencies (`flutter packages get` or `pub get`).
19+
1. Squash your commits and ensure you have a meaningful commit message.
20+
1. If you’ve fixed a bug or added code that should be tested, add tests!
21+
Pull Requests without 100% test coverage will not be approved.
22+
1. Ensure the test suite passes.
23+
1. If you've changed the public API, make sure to update/add documentation.
24+
1. Format your code (`dart format .`).
25+
1. Analyze your code (`dart analyze --fatal-infos --fatal-warnings .`).
26+
1. Create the Pull Request.
27+
1. Verify that all status checks are passing.
28+
29+
While the prerequisites above must be satisfied before having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
30+
31+
## Getting in Touch
32+
33+
If you want to just ask a question or get feedback on an idea, you can post it as a GitHub issue.
34+
35+
## License
36+
37+
By contributing to animated_svg, you agree that your contributions will be licensed under its [license](LICENSE).

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 BBK Development
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[![Powered by Mason](https://img.shields.io/endpoint?url=https%3A%2F%2Ftinyurl.com%2Fmason-badge)](https://github.com/felangel/mason)
55
[![License: MIT][license_badge]][license_link]
66

7-
Audio Player Service
7+
This service wraps the [just_audio][just_audio_link] and provides secure usage of the plugin by handling exceptions.
88

99
## Installation 💻
1010

@@ -57,6 +57,7 @@ genhtml coverage/lcov.info -o coverage/
5757
open coverage/index.html
5858
```
5959

60+
[just_audio_link]: https://github.com/ryanheise/just_audio
6061
[flutter_install_link]: https://docs.flutter.dev/get-started/install
6162
[github_actions_link]: https://docs.github.com/en/actions/learn-github-actions
6263
[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg

lib/src/audio_player_service.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class AudioListenerException implements Exception {}
2929
/// {@template audio_player_service}
3030
/// A service that handles audio playback.
3131
///
32-
/// This service uses the [AudioPlayer] package to play audio.
32+
/// This service uses the `just_audio` package to play audio.
3333
///
3434
/// ```dart
3535
/// final audioPlayerService = AudioPlayerService(

pubspec.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
name: audio_player_service
22
description: Audio Player Service
3-
version: 0.1.0+1
3+
version: 1.0.0
44
publish_to: none
55

66
environment:
@@ -16,4 +16,4 @@ dev_dependencies:
1616
flutter_test:
1717
sdk: flutter
1818
mocktail: ^0.3.0
19-
very_good_analysis: ^5.0.0
19+
very_good_analysis: ^5.0.0

0 commit comments

Comments
 (0)