Update README.md, pubspec.yaml, work on example and linter warnings

flutter · auto-submit · Dec 4, 2024 · Jun 5, 2024 · Jun 5, 2024 · Jul 21, 2024
commit 605008758c4a051970fe47185e88e684decb3979
@@ -1,3 +1,3 @@
-## 0.0.1
+## 0.1.0
 
-* Initial MVP release.
+* Initial release.
@@ -1,39 +1,32 @@
-Plugin allowing Adsense integration with Flutter Web 
-
-[//]: # (## Features)
-
-[//]: # ()
-[//]: # (TODO: List what your package can do. Maybe include images, gifs, or videos.)
-
-[//]: # ()
-[//]: # (## Getting started)
-
-[//]: # ()
-[//]: # (TODO: List prerequisites and provide or point to information on how to)
-
-[//]: # (start using the package.)
-
-[//]: # ()
-[//]: # (## Usage)
-
-[//]: # ()
-[//]: # (TODO: Include short and useful examples for package users. Add longer examples)
-
-[//]: # (to `/example` folder.)
-
-[//]: # ()
-[//]: # (```dart)
-
-[//]: # (const like = 'sample';)
-
-[//]: # (```)
-
-[//]: # ()
-[//]: # (## Additional information)
-
-[//]: # ()
-[//]: # (TODO: Tell users more about the package: where to find more information, how to)
-
-[//]: # (contribute to the package, how to file issues, what response they can expect)
-
-[//]: # (from the package authors, and more.)
+# google_adsense
+[Google AdSense](https://adsense.google.com/intl/en_us/start/) plugin for Flutter Web
+
+Generally integration with AdSense requires:
+
+1. Adding an [AdSense code](https://support.google.com/adsense/answer/9274634?hl=en&ref_topic=28893&sjid=9002959242386336076-EU) usually in between the `<head></head>` tag to connect your site with AdSense account. Allows using **Auto ads**
+2.  Adding [ad unit code](https://support.google.com/adsense/answer/9274025?sjid=9002959242386336076-EU) in between the `<body><body/>` tags of your pages where you want ad to appear. Ad unit code snippet is unique per **ad unit** that you need to create in your AdSense account first. You might have several ad units added to your website
+
+Since Flutter apps are not rendered as traditional HTML pages and there is no easy way to access final DOM tree from Dart, this plugin provides a Widget (`AdViewWidget`) that you can configure as an ad unit and place in the desired location in your app UI
+
+
+## Installation
+run `flutter pub add google_adsense`
+
+## Usage
+#### Initialize AdSense
+Before displaying ads, initialize the AdSense with your ad client ID.
+```dart
+import 'package:google_adsense/adsense.dart';
+
+void main() {
+  Adsense().initialize('your-ad-client-id');
+}
+```
+#### Display AdViewWidget
+```dart
+import 'package:google_adsense/adsense.dart';
+// ...
+val adWidget = Adsense().adView(
+  adSlot: 'your-ad-slot-id',
+);
+```
diff --git a/packages/google_adsense/lib/adsense.dart b/packages/google_adsense/lib/adsense.dart
@@ -1,3 +1 @@
-library adsense_web_standalone;
-
 export 'src/adsense_stub.dart' if (dart.library.html) 'src/adsense_web.dart';
@@ -10,7 +10,7 @@ import 'ad_view_widget.dart';
 
 class Adsense {
   static final Adsense _instance = Adsense._internal();
-  static bool isInitialized = false;
+  static bool _isInitialized = false;
 
   Adsense._internal();
 
@@ -19,11 +19,11 @@ class Adsense {
   }
 
   void initialize(String adClient) {
-    if (isInitialized) {
+    if (_isInitialized) {
       log('Adsense was already initialized, skipping');
       return;
     }
-    isInitialized = true;
+    _isInitialized = true;
     _addMasterScript(adClient);
   }
 
@@ -49,7 +49,7 @@ class Adsense {
   }
 
   static void _addMasterScript(String adClient) {
-    web.HTMLScriptElement scriptElement = web.HTMLScriptElement();
+    final web.HTMLScriptElement scriptElement = web.HTMLScriptElement();
     scriptElement.async = true;
     scriptElement.src =
         'https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-$adClient';

@@ -1,58 +1,26 @@
 name: google_adsense
 description: Google Adsense plugin for Flutter Web
+repository: https://github.com/flutter/packages/tree/main/packages/google_adsense
+issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+google_adsense%22
 version: 0.0.1
-homepage:
 
 environment:
-  sdk: '>=3.1.0 <4.0.0'
-  flutter: ">=1.17.0"
+  sdk: ^3.1.0
+  flutter: ^1.17.0
 
 dependencies:
   flutter:
     sdk: flutter
   web: ^0.5.1
 
 dev_dependencies:
+  build_runner: ^2.4.9
+  flutter_lints: ^2.0.0
   flutter_test:
     sdk: flutter
-  flutter_lints: ^2.0.0
-  test: ^1.24.9
   mockito: ^5.4.4
-  build_runner: ^2.4.9
-
-# For information on the generic Dart part of this file, see the
-# following page: https://dart.dev/tools/pub/pubspec
-
-# The following section is specific to Flutter packages.
-flutter:
-
-# To add assets to your package, add an assets section, like this:
-# assets:
-#   - images/a_dot_burr.jpeg
-#   - images/a_dot_ham.jpeg
-#
-# For details regarding assets in packages, see
-# https://flutter.dev/assets-and-images/#from-packages
-#
-# An image asset can refer to one or more resolution-specific "variants", see
-# https://flutter.dev/assets-and-images/#resolution-aware
+  test: ^1.24.9
 
-# To add custom fonts to your package, add a fonts section here,
-# in this "flutter" section. Each entry in this list should have a
-# "family" key with the font family name, and a "fonts" key with a
-# list giving the asset and other descriptors for the font. For
-# example:
-# fonts:
-#   - family: Schyler
-#     fonts:
-#       - asset: fonts/Schyler-Regular.ttf
-#       - asset: fonts/Schyler-Italic.ttf
-#         style: italic
-#   - family: Trajan Pro
-#     fonts:
-#       - asset: fonts/TrajanPro.ttf
-#       - asset: fonts/TrajanPro_Bold.ttf
-#         weight: 700
-#
-# For details regarding fonts in packages, see
-# https://flutter.dev/custom-fonts/#from-packages
+topics:
+  - monetization
+  - ads
Original file line number	Diff line number	Diff line change
		@@ -1,3 +1 @@
		library adsense_web_standalone;

		export 'src/adsense_stub.dart' if (dart.library.html) 'src/adsense_web.dart';