Update: Change LICENSE, CHANGELOG.md, etc.

TEGRAXD · Feb 5, 2022 · 774a14e · 774a14e
1 parent 5a31b1a
commit 774a14e
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,3 @@
-## 0.0.1
+## 0.0.1 (2022-02-05)
 
-* TODO: Describe initial release.
+* Initial release, currently only work for Android.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Tegar Bangun Suganda, ASTARIA.
+Copyright (c) 2022 Tegar Bangun Suganda (ASTARIA)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 Resonance
 ====
-Resonance is flutter volume controller plugin
+Resonance is flutter volume controller and vibration plugin
 
 ![](static/resonance.png)
 
@@ -13,32 +13,34 @@ Features
 - Set mute volume level
 - Showing volume UI (Android only)
 - Volume stream types (music, notification, alarm, etc.)
-- Listenable volume changes
+- Listenable volume level
 
 Usage
 -----
 
 Get current volume level
 
 ```dart
-var crntVol = await Resonance.getCurrentVolumeLevel();
+/// [streamType] by the default is set to [StreamType.music]
+var crntVol = await Resonance.getCurrentVolumeLevel(streamType: StreamType.alarm);
 print(crntVol);
 ```
 
 Set volume level
 
 ```dart
-/// [showVolumeUI] default parameter set to false
+/// [showVolumeUI] by the default is set to false
 var crntVol = await Resonance.setVolumeLevel(0.5, showVolumeUI: true);
 print(crntVol);
 ```
 
-Add listener
+Listener
 
 ```dart
 @override
 void initState() {
     super.initState();
+    /// Add listener
     Resonance().addListener((volume) {
         setState(() {
             _volumeLevel = volume;
@@ -56,11 +58,12 @@ void dispose() {
 
 Status
 ------
-Version 1.0.0 is under development
+Version 0.0.1 is under development
 
 Note
 ------
-Currently, plugin only available only for Android devices
+Currently, the plugin only available for Android.
+Pull requests and contributors are welcome.
 
 Developer
 ------
@@ -76,7 +79,7 @@ License
 ```
 MIT License
 
-Copyright (c) 2022 Tegar Bangun Suganda, ASTARIA.
+Copyright (c) 2022 Tegar Bangun Suganda (ASTARIA)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,7 +1,7 @@
 name: resonance
-description: A new Flutter project.
+description: Resonance is flutter volume controller and vibration plugin
 version: 0.0.1
-homepage:
+homepage: https://github.com/suganda8/resonance.git
 
 environment:
   sdk: ">=2.15.1 <3.0.0"