chore: Preparing to Publish FlutterFire Configurator on pub.dev (#36)

* doc: Update FlutterFire Configurator README * doc: Add MIT License to project * doc: Update pubspec.yaml with new homepage, repository, and issue tracker URLs * Update LICENSE Co-authored-by: Ryunosuke Muramatsu <[email protected]> * chore: Remove word from organization-words.txt --------- Co-authored-by: Ryunosuke Muramatsu <[email protected]>
altive · Dec 22, 2023 · 67a6f5e · 67a6f5e
1 parent 62f405a
commit 67a6f5e
Show file tree

Hide file tree

Showing 5 changed files with 46 additions and 32 deletions.
diff --git a/.cspell/organization-words.txt b/.cspell/organization-words.txt
@@ -2,4 +2,4 @@
 altive
 muramatsu
 naipaka
-riscait
+riscait
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Altive Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/flutterfire_configurator/LICENSE b/packages/flutterfire_configurator/LICENSE
@@ -0,0 +1 @@
+../../LICENSE
diff --git a/packages/flutterfire_configurator/README.md b/packages/flutterfire_configurator/README.md
@@ -1,39 +1,29 @@
-<!--
-This README describes the package. If you publish this package to pub.dev,
-this README's contents appear on the landing page for your package.
+# FlutterFire Configurator
 
-For information about how to write a good package README, see the guide for
-[writing package pages](https://dart.dev/guides/libraries/writing-package-pages).
-
-For general information about developing packages, see the Dart guide for
-[creating packages](https://dart.dev/guides/libraries/create-library-packages)
-and the Flutter guide for
-[developing packages and plugins](https://flutter.dev/developing-packages).
--->
-
-TODO: Put a short description of the package here that helps potential users
-know whether this package might be useful for them.
-
-## Features
-
-TODO: List what your package can do. Maybe include images, gifs, or videos.
+Provides a wrapper class for the FlutterFire RemoteConfig package to simplify its usage.
 
 ## Getting started
 
-TODO: List prerequisites and provide or point to information on how to
-start using the package.
+```yaml
+dependencies:
+  flutterfire_configurator: any
+```
 
 ## Usage
 
-TODO: Include short and useful examples for package users. Add longer examples
-to `/example` folder.
+1. Create an instance of `Configurator`.
+2. Set default values as needed.
+3. Use the instance of `Configurator` to retrieve configuration values. You can specify a callback in `onConfigUpdated` that is called when the configuration values are updated.
 
 ```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.
+final configurator = Configurator();
+...
+await configurator.setDefaultConfig({'int_parameter', 123});
+...
+final intConfig = configurator.getIntConfig(
+  'int_parameter',
+  onConfigUpdated: (value) {
+    print('int_parameter: $value');
+  },
+);
+```
diff --git a/packages/flutterfire_configurator/pubspec.yaml b/packages/flutterfire_configurator/pubspec.yaml
@@ -1,7 +1,9 @@
 name: flutterfire_configurator
 description: flutterfire_configurator with FlutterFire Remote Config.
-publish_to: "none"
 version: 0.1.0
+homepage: https://altive.dev
+repository: https://github.com/altive/flutterfire_adapter
+issue_tracker: https://github.com/altive/flutterfire_adapter/issues
 
 environment:
   sdk: ^3.0.0
-Original file line number
+Diff line change
@@ Expand Up / @@ -2,4 +2,4 @@ @@
     altive
     muramatsu
     naipaka
-    riscait
+    riscait