From 0def0bee1fa90e31e564846e5025e9bbb401c62a Mon Sep 17 00:00:00 2001 From: naipaka Date: Fri, 22 Dec 2023 16:06:43 +0900 Subject: [PATCH 1/5] doc: Update FlutterFire Configurator README --- packages/flutterfire_configurator/README.md | 50 +++++++++------------ 1 file changed, 20 insertions(+), 30 deletions(-) diff --git a/packages/flutterfire_configurator/README.md b/packages/flutterfire_configurator/README.md index 02fe8ec..f71651c 100644 --- a/packages/flutterfire_configurator/README.md +++ b/packages/flutterfire_configurator/README.md @@ -1,39 +1,29 @@ - - -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'); + }, +); +``` \ No newline at end of file From 2ac9af098e068a6b150e4ae9f0ce8856e5e1b035 Mon Sep 17 00:00:00 2001 From: naipaka Date: Fri, 22 Dec 2023 16:24:45 +0900 Subject: [PATCH 2/5] doc: Add MIT License to project --- .cspell/organization-words.txt | 3 ++- LICENSE | 21 +++++++++++++++++++++ packages/flutterfire_configurator/LICENSE | 1 + 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 LICENSE create mode 120000 packages/flutterfire_configurator/LICENSE diff --git a/.cspell/organization-words.txt b/.cspell/organization-words.txt index 6f46ec2..464d6a0 100644 --- a/.cspell/organization-words.txt +++ b/.cspell/organization-words.txt @@ -2,4 +2,5 @@ altive muramatsu naipaka -riscait \ No newline at end of file +riscait +Ryunosuke diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c37a02c --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2022 Muramatsu Ryunosuke (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 new file mode 120000 index 0000000..30cff74 --- /dev/null +++ b/packages/flutterfire_configurator/LICENSE @@ -0,0 +1 @@ +../../LICENSE \ No newline at end of file From 5e375466ef76735b6a76a4ff2254b12f040fd218 Mon Sep 17 00:00:00 2001 From: naipaka Date: Fri, 22 Dec 2023 16:34:15 +0900 Subject: [PATCH 3/5] doc: Update pubspec.yaml with new homepage, repository, and issue tracker URLs --- packages/flutterfire_configurator/pubspec.yaml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/flutterfire_configurator/pubspec.yaml b/packages/flutterfire_configurator/pubspec.yaml index 3ee4f85..1cac1d1 100644 --- 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 From 60c14ab8f4eb3c01a312451f7fdab35d30f2449d Mon Sep 17 00:00:00 2001 From: Ryota Kobayashi <45661924+naipaka@users.noreply.github.com> Date: Fri, 22 Dec 2023 17:04:34 +0900 Subject: [PATCH 4/5] Update LICENSE Co-authored-by: Ryunosuke Muramatsu --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index c37a02c..eeb2058 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 Muramatsu Ryunosuke (Altive Inc) +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 From bd2cbfe94ca0edd0d03b543cbd1e85a192fbd910 Mon Sep 17 00:00:00 2001 From: naipaka Date: Fri, 22 Dec 2023 17:05:23 +0900 Subject: [PATCH 5/5] chore: Remove word from organization-words.txt --- .cspell/organization-words.txt | 1 - 1 file changed, 1 deletion(-) diff --git a/.cspell/organization-words.txt b/.cspell/organization-words.txt index 464d6a0..0b70e41 100644 --- a/.cspell/organization-words.txt +++ b/.cspell/organization-words.txt @@ -3,4 +3,3 @@ altive muramatsu naipaka riscait -Ryunosuke