[REFAC] Readme and analysis options with fixing lint problems

Author: TobiasRump

README.md

@@ -1,120 +1,120 @@
 # flutter_text_decorator
+![Flutter Text Decorator Logo][logo_white]
+![Flutter Text Decorator Logo][logo_black]
 
-![License](https://img.shields.io/github/license/EXXETA/flutter_tex_dec)
-<!-- ![Release](https://img.shields.io/github/release/EXXETA/flutter_tex_dec) -->
-<!-- [![pub package](https://img.shields.io/pub/v/flutter_tex_dec)](https://pub.dev/packages/flutter_tex_dec) -->
-
-![Screenshot of Feature Grid](./documentation/img/overview.png)
+[![License: MIT][license_badge]][license_link]
+[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
 
 Bring your words to life leveraging flutter_text_decorator with wavy underlines, colorful boxes, speech bubbles and more. Whether you want to highlight important details, add a playful touch or simply stand out. The package makes it easy to add personality and flair to your text.
 
+Developed with passion by [**EXXETA**](https://www.exxeta.com)
+
 ## Features
 
-- [x] Boxes
-- [x] Underline
-- [x] Wavy Box
-- [x] Speech Bubble
+- ✅ Boxes
+- ✅ Underline
+- ✅ Wavy Box
+- ✅ Speech Bubble
 
 Feel free to check out the [Example App](./example) and play around.
 
-## Installation
-
-### pub.dev
-
-Add flutter_text_decorator as dependency to `pubspec.yaml`:
-
-```
-dependencies:
-  flutter_tex_dec: ^0.1.0
-```
-
-## Usage
-
-### Box Decorator
-
-```
-TextDecorator.boxed(
-  style: BoxStyle.rounded,
-  text: const Text(
-    'Rounded Box',
-    style: TextStyle(fontSize: 32),
-  ),
-  strokeWidth: 2,
-),
-```
-
-![Box Decorator Example](./documentation/img/box.png)
-
-### Circle Decorator
-
-```
-TextDecorator.circled(
-  style: CircleStyle.circled,
-  text: const Text(
-    'Circled Text',
-    style: TextStyle(fontSize: 32),
-  ),
-),
-```
-
-![Circle Decorator Example](./documentation/img/circle.png)
-
-### Underline Decorator
+## Quick Start 🚀
+
+1.  **Add `flutter_text_decorator` to your `pubspec.yaml`**
+
+    ```yaml
+    dependencies:
+      flutter_text_decorator:
+    ```
+
+2.  **Run the following terminal command to install the package:**
+    ```sh
+    flutter pub get
+    ```
+
+3.  **Import the package into your Dart file**
+
+    ```sh
+    import 'package:flutter_text_decorator/flutter_text_decorator.dart';
+    ```
+
+4.  **Use TextDecorator**
+
+    Here is a simple example of how you can use `TextDecorator.boxed`:
+    ```dart
+    import 'package:flutter/material.dart';
+    import 'package:flutter_text_decorator/flutter_text_decorator.dart';
+
+    class MyDecoratedWidget extends StatelessWidget {
+      const MyDecoratedWidget({super.key});
+
+      @override
+      Widget build(BuildContext context) {
+        return Center(
+          child: TextDecorator.boxed(
+            style: BoxStyle.rounded,
+            text: const Text(
+              'Hello Decorated World!',
+              style: TextStyle(fontSize: 24, color: Colors.white),
+            ),
+            color: Colors.blueAccent,
+            strokeWidth: 2,
+          ),
+        );
+      }
+    }
+    ```
+
+
+## Styles Preview
+
+<table>
+  <tr>
+    <td align="center">
+      <h3>Box Decorator</h3>
+      <img src="./documentation/img/box.png" alt="Box Decorator Example" width="80%">
+    </td>
+    <td align="center">
+      <h3>Circle Decorator</h3>
+      <img src="./documentation/img/circle.png" alt="Circle Decorator Example" width="80%">
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <h3>Underline Decorator</h3>
+      <img src="./documentation/img/underline.png" alt="Underline Decorator Example" width="80%">
+    </td>
+    <td align="center">
+      <h3>Highlight Decorator</h3>
+      <img src="./documentation/img/highlight.png" alt="Highlight Decorator Example" width="80%">
+    </td>
+  </tr>
+</table>
+
+
+## Planned features 🎯
+
+We're always thinking of new ways to make text decoration even more fun and versatile! Our next big idea is to introduce a **Comic effect** to bring a playful, graphic-novel style to your Flutter apps. Stay tuned for this and other enhancements.
 
-```
-TextDecorator.underlined(
-  style: UnderlineStyle.horizontal,
-  text: const Text(
-    'Underlined Text',
-    style: TextStyle(fontSize: 24),
-  ),
-  color: Colors.orange,
-  strokeWidth: 2,
-),
-```
-
-![Underline Decorator Example](./documentation/img/underline.png)
-
-### Highlight Decorator
-
-```
-TextDecorator.highlighted(
-  style: HighlightStyle.marker,
-  text: const Text(
-    'Highlighted Text',
-    style: TextStyle(fontSize: 32),
-  ),
-),
-```
-
-![Underline Decorator Example](./documentation/img/highlight.png)
-
-## Roadmap
-
-### TODO's
-
-- [ ] Fix Wavy Box corners
-- [ ] Add test automation
-
-### Planned features
-
-- [ ] Comic effect
 
 ## Contributing
+We love new ideas and contributions from the community! If you have a suggestion, a bug report, or want to contribute code, please check out our [CONTRIBUTING](./CONTRIBUTING.md) guide to get started. Your input helps make `flutter_text_decorator` even better!
 
-See [CONTRIBUTING](./CONTRIBUTING.md)
 
-## Authors and acknowledgment
+## Authors 
 
 Authors:
 
 - [Tobias Rump](https://github.com/TobiasRump)
 - [Jonas Klock](https://github.com/jay-k98)
 
-Special Thanks:
-
-- Noah Bauer for the creative name of this package
-
 ## License
-
-See [LICENSE](./LICENSE)
+This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
+
+[logo_black]: ./assets/flutter_text_decorator_logo_dark.png#gh-light-mode-only
+[logo_white]: ./assets/flutter_text_decorator_logo_light.png#gh-dark-mode-only
+[license_link]: https://opensource.org/licenses/MIT
+[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
+[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
+[very_good_ventures_link]: https://verygood.ventures

analysis_options.yaml

@@ -1,114 +1,7 @@
-include: package:flutter_lints/flutter.yaml
+include: package:very_good_analysis/analysis_options.yaml
 
 linter:
   rules:
-    # Error
-    - always_use_package_imports
-    - avoid_empty_else
-    - avoid_slow_async_io
-    - avoid_types_as_parameter_names
-    - cancel_subscriptions
-    - collection_methods_unrelated_type
-    - control_flow_in_finally
-    - deprecated_member_use_from_same_package
-    - empty_statements
-    - hash_and_equals
-    - literal_only_boolean_expressions
-    - no_duplicate_case_values
-    - no_logic_in_create_state
-    - no_self_assignments
-    - no_wildcard_variable_uses
-    - test_types_in_equals
-    - unnecessary_statements
-    - use_build_context_synchronously
-    - use_key_in_widget_constructors
-    - valid_regexps
-
-    # Style
-    - always_put_required_named_parameters_first
-    - annotate_overrides
-    - annotate_redeclares
-    - avoid_bool_literals_in_conditional_expressions
-    - avoid_function_literals_in_foreach_calls
-    - avoid_init_to_null
-    - avoid_private_typedef_functions
-    - avoid_positional_boolean_parameters
-    - avoid_redundant_argument_values
-    - avoid_return_types_on_setters
-    - avoid_returning_null_for_void
-    - avoid_returning_this
-    - avoid_shadowing_type_parameters
-    - avoid_unnecessary_containers
-    - avoid_void_async
-    - await_only_futures
-    - camel_case_extensions
-    - camel_case_types
-    - cascade_invocations
-    - cast_nullable_to_non_nullable
-    - curly_braces_in_flow_control_structures
-    - directives_ordering
-    - do_not_use_environment
-    - empty_catches
-    - empty_constructor_bodies
-    - exhaustive_cases
-    - file_names
-    - implementation_imports
-    - implicit_call_tearoffs
-    - leading_newlines_in_multiline_strings
-    - matching_super_parameters
-    - no_literal_bool_comparisons
-    - null_closures
-    - null_check_on_nullable_type_parameter
-    - one_member_abstracts
-    - prefer_adjacent_string_concatenation
-    - prefer_conditional_assignment
-    - prefer_const_constructors
-    - prefer_contains
-    - prefer_final_in_for_each
-    - prefer_final_locals
-    - prefer_for_elements_to_map_fromIterable
-    - prefer_foreach
-    - prefer_generic_function_type_aliases
-    - prefer_if_elements_to_conditional_expressions
-    - prefer_if_null_operators
-    - prefer_initializing_formals
-    - prefer_inlined_adds
-    - prefer_interpolation_to_compose_strings
-    - prefer_is_empty
-    - prefer_is_not_empty
-    - prefer_is_not_operator
-    - prefer_iterable_whereType
-    - prefer_null_aware_method_calls
-    - prefer_null_aware_operators
-    - prefer_typing_uninitialized_variables
-    - recursive_getters
-    - require_trailing_commas
-    - sized_box_for_whitespace
-    - sized_box_shrink_expand
-    - sort_child_properties_last
-    - sort_unnamed_constructors_first
-    - unawaited_futures
-    - unnecessary_await_in_return
-    - unnecessary_brace_in_string_interps
-    - unnecessary_breaks
-    - unnecessary_const
-    - unnecessary_constructor_name
-    - unnecessary_getters_setters
-    - unnecessary_lambdas
-    - unnecessary_new
-    - unnecessary_null_aware_assignments
-    - unnecessary_null_in_if_null_operators
-    - unnecessary_nullable_for_final_variable_declarations
-    - unnecessary_overrides
-    - unnecessary_string_escapes
-    - unnecessary_string_interpolations
-    - unnecessary_this
-    - unnecessary_to_list_in_spreads
-    - use_colored_box
-    - use_decorated_box
-    - use_full_hex_values_for_flutter_colors
-    - use_rethrow_when_possible
-
-    # Docs
-    - slash_for_doc_comments
- 
+    lines_longer_than_80_chars: false
+    public_member_api_docs: false
+   

assets/flutter_text_decorator_logo_dark.png

@@ -34,7 +34,7 @@ android {
     }
 
     defaultConfig {
-        // TODO: Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
+       // TODO(everyone): Specify your own unique Application ID (https://developer.android.com/studio/build/application-id.html).
         applicationId = "com.example.example"
         // You can update the following values to match your application needs.
         // For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration.
@@ -46,7 +46,7 @@ android {
 
     buildTypes {
         release {
-            // TODO: Add your own signing config for the release build.
+           // TODO(everyone): Add your own signing config for the release build.
             // Signing with the debug keys for now, so `flutter run --release` works.
             signingConfig = signingConfigs.debug
         }

assets/flutter_text_decorator_logo_light.png

@@ -1,4 +1,3 @@
-library flutter_text_decorator;
 
 export 'src/modules/base/styles.dart';
 export 'src/widgets/text_draw_decorator.dart';

example/android/app/build.gradle

@@ -1,4 +1,5 @@
 import 'package:flutter/material.dart';
+import 'package:flutter_text_decorator/src/modules/circle/decorations/circle_decoration.dart';
 
 /// An abstract base class for defining common styling properties for text decorations.
 ///
@@ -7,11 +8,11 @@ import 'package:flutter/material.dart';
 /// like [color] and [strokeWidth].
 ///
 abstract class DecorationBase {
-  final Color color;
-  final double strokeWidth;
 
   const DecorationBase({
     required this.color,
     required this.strokeWidth,
   });
+  final Color color;
+  final double strokeWidth;
 }