Merge pull request #2 from suganda8/dev-alpha

Version 1.0.3 ready to released
TEGRAXD · Apr 16, 2023 · 306bc10 · 306bc10
2 parents 7b48471 + 3796b0f
commit 306bc10
Show file tree

Hide file tree

Showing 14 changed files with 145 additions and 120 deletions.
diff --git a/.github/workflows/dart.yml b/.github/workflows/dart.yml
@@ -42,7 +42,7 @@ jobs:
 
       # Uncomment this step to verify the use of 'dart format' on each commit.
       - name: Plugin - Verify formatting
-        run: flutter format --set-exit-if-changed .
+        run: dart format --set-exit-if-changed .
 
       # Statically analyze the Dart code for any errors.
       - name: Plugin - Analizing errors
@@ -61,7 +61,7 @@ jobs:
       # Uncomment this step to verify the use of 'dart format' on each commit.
       - name: Example - Verify formatting
         working-directory: ./example
-        run: flutter format --set-exit-if-changed .
+        run: dart format --set-exit-if-changed .
 
       # Statically analyze the Dart code for any errors.
       - name: Example - Analizing errors

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,4 +4,8 @@
 
 ## 1.0.2 (2022-02-11)
 
-* Improving README.md and official icon, renaming volume controller method and add vibration method (one-time, pattern and repeat, cancel vibration).
+* Improving README.md and official icon, renaming volume controller method and add vibration method (one-time, pattern and repeat, cancel vibration).
+
+## 1.0.3 (2023-04-16)
+
+* Improving documentation readability
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -20,7 +20,7 @@ flutter test
 The main objective of our GitHub issue is to track bugs and and errors. If you have encounter an issue or bug and not able to fix it yourself, feel free to open an issue. We do not rule out that the issues could be a feature enhancement request.
 And please provide us spesific details of the issue, it will make a lot easier for us maintainers to elaborate and reproduce the issue. We will then take care of the issue as soon as possible. 
 
-> You must never report security related issues, vulnerabilities, or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <suganda@astaria.space>.
+> You must never report security related issues, vulnerabilities, or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <support@overmindworks.site>.
 
 ### Bug reports
 - Determine that the bug is a reproducible bug and not an error on your side e.g. using incompatible environment components/versions.

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,8 @@
+resonance
+
 MIT License
 
-Copyright (c) 2022 Tegar Bangun Suganda (ASTARIA)
+Copyright (c) 2022 Tegar Bangun Suganda (OVERMIND)
 
 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,12 +1,12 @@
 # Resonance ![Dart](https://github.com/suganda8/resonance/actions/workflows/dart.yml/badge.svg)
 
-Resonance is volume controller and vibration plugin
+Resonance is volume and vibration controller plugin. This plugin based on the Android volume and vibration controller. The plugin let you control volume without user interaction and allow customable vibration pattern.
 
 ![](static/resonance.png)
 
 ## Download
 
-Get the latest plugin directly from [Pub.dev][1].
+Get the latest plugin directly from [Pub][1].
 
 ## Features
 
@@ -30,15 +30,13 @@ Get the latest plugin directly from [Pub.dev][1].
 - Get current volume level
 
 ```dart
-/// [streamType] by the default is set to [StreamType.music]
 var crntVol = await Resonance.volumeGetCurrentLevel(streamType: StreamType.alarm);
 print(crntVol);
 ```
 
 - Set volume level
 
 ```dart
-/// [showVolumeUI] by the default is set to false
 var crntVol = await Resonance.volumeSetLevel(0.5, showVolumeUI: true);
 print(crntVol);
 ```
@@ -50,7 +48,7 @@ double _volumeLevel = 0;
 
 @override
 void initState() {
-    /// Add listener inside initState
+    // Add listener
     Resonance().addVolumeListener((volume) {
         setState(() {
             _volumeLevel = volume;
@@ -61,7 +59,7 @@ void initState() {
 
 @override
 void dispose() {
-    /// Don't forget to use [removeVolumeListener] after
+    // Remove listener
     Resonance().removeVolumeListener();
     super.dispose();
 }
@@ -91,7 +89,7 @@ await Resonance.vibrationCancel();
 
 ## Status
 
-Version 1.0.3 is under development
+Version 1.0.3 is released
 
 ## Note
 
@@ -124,9 +122,11 @@ Tegar Bangun Suganda
 ## License
 
 ```
+resonance
+
 MIT License
 
-Copyright (c) 2022 Tegar Bangun Suganda (ASTARIA)
+Copyright (c) 2022 Tegar Bangun Suganda (OVERMIND)
 
 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/android/build.gradle b/android/build.gradle
@@ -2,10 +2,7 @@ group 'com.astaria.resonance'
 version '1.0-SNAPSHOT'
 
 buildscript {
-    // ext.kotlin_version = '1.3.50'
-    // ext.kotlin_version = '1.4.32'
-    // ext.kotlin_version = '1.5.30'
-    ext.kotlin_version = '1.6.10'
+    ext.kotlin_version = '1.8.20'
     repositories {
         google()
         mavenCentral()

diff --git a/android/gradle/wrapper/gradle-wrapper.properties b/android/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.8-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-6.8.3-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/example/README.md b/example/README.md
@@ -2,15 +2,5 @@
 
 Demonstrates how to use the resonance plugin.
 
-## 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.
+- [Pub](https://pub.dev/packages/resonance)
+- [Github](https://github.com/suganda8/resonance)
diff --git a/example/android/build.gradle b/example/android/build.gradle
@@ -1,13 +1,12 @@
 buildscript {
-    // ext.kotlin_version = '1.3.50'
-    ext.kotlin_version = '1.6.10'
+    ext.kotlin_version = '1.8.20'
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
-        classpath 'com.android.tools.build:gradle:4.1.0'
+        classpath 'com.android.tools.build:gradle:7.2.1'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
     }
 }

diff --git a/example/android/gradle/wrapper/gradle-wrapper.properties b/example/android/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
-#Fri Jun 23 08:50:38 CEST 2017
+#Mon Apr 03 16:02:40 ICT 2023
 distributionBase=GRADLE_USER_HOME
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.3-bin.zip
 distributionPath=wrapper/dists
-zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.7-all.zip
+zipStoreBase=GRADLE_USER_HOME