Skip to content

Commit

Permalink
Feature/fix doc (#9)
Browse files Browse the repository at this point in the history
* Fix @Nodoc directive in build_settings_codec.dart

* Update README.md
  • Loading branch information
meg4cyberc4t authored Feb 21, 2024
1 parent 44ca27a commit 6e4434c
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 11 deletions.
29 changes: 19 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,43 @@
# Varioqub Configs

Flutter plugin providing work with remote configs, experiments and A/B testing via Varioqub
### Flutter plugin providing work with remote configs, experiments and A/B testing via <a href="https://varioqub.ru/">Varioqub</a>.

# Example of using

```dart
final varioqub = VarioqubConfigs();
await varioqub.build(
const BuildSettings(client: VarioqubClient.appmetrica('XXXXXXX')), //your AppMetrica application ID
/// Initializing configs instance
final configs = VarioqubConfigs();
await configs.build(
const BuildSettings(client: VarioqubClient.appmetrica('XXXXXXX')), // Your AppMetrica application ID
);
await varioqub.activateConfig();
/// Activation of previous configs.
/// It is recommended to activate the configuration during application startup.
await configs.activateConfig();
await varioqub.fetchConfig();
/// Extracting configs from Varioqub.
/// It is recommended to fetch the configuration during the application without waiting.
await configs.fetchConfig();
await varioqub.getString(
/// Getting the config by "FLAG" key.
await configs.getString(
key: 'FLAG',
defaultValue: 'DEFAULT_VALUE',
);
```

# Sources
[What is Varioqub?](https://varioqub.ru/)

[What is Varioqub? (The main website of the Varioqub project)](https://varioqub.ru/)

[Official docs from Yandex](https://yandex.ru/support2/varioqub-app/ru/)

# Limitations

At the moment, the library is used exclusively for obtaining and working with configs and experiments. Analytics elements are not used for fetch!

# Changelog

[Refer to the Changelog to get all release notes.](https://github.com/meg4cyberc4t/varioqub_configs/blob/main/CHANGELOG.md)

# Maintainers
Expand All @@ -39,4 +47,5 @@ At the moment, the library is used exclusively for obtaining and working with co
This library is open for issues and pull requests. If you have ideas for improvements or bugs, the repository is open to contributions!

# License
[MIT](https://opensource.org/license/mit/)

[MIT](https://opensource.org/license/mit/)
2 changes: 1 addition & 1 deletion lib/src/build_settings/build_settings_codec.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import 'dart:convert';
import 'package:varioqub_configs/src/messages.g.dart';
import 'package:varioqub_configs/varioqub_configs.dart';

/// {@nodoc}
/// @nodoc
const buildSettingsCodec = _BuildSettingsCodec();

class _BuildSettingsCodec extends Codec<BuildSettings, PigeonBuildSettings> {
Expand Down

0 comments on commit 6e4434c

Please sign in to comment.