README.template.md

{{ ossHeader }}

Momento Dart SDK

To get started with Momento you will need a Momento API key. You can get one from the Momento Console.

• Website: https://www.gomomento.com/
• Momento Documentation: https://docs.momentohq.com/
• Getting Started: https://docs.momentohq.com/getting-started
• Discuss: Momento Discord

Packages

The Momento Dart SDK is available on pub.dev

To install in your Dart program, use:

dart pub add momento

To install in your Flutter program, use:

flutter pub add momento

Usage

Check out our example directory for complete examples of using the Momento Dart SDK to implement a publish and subscribe system in a basic Dart program and in a Flutter app.

Here is a quickstart you can use for your own project:

{% include "./example/quickstart/bin/quickstart.dart" %}

Getting Started and Documentation

General documentation on Momento and the Momento SDKs is available on the Momento Docs website. Specific usage examples for the Dart SDK are coming soon!

Examples

Check out full working code in the example directory of this repository!

Logging

There is a LogLevel enum that contains the following log levels:

• LogLevel.trace
• LogLevel.debug
• LogLevel.info
• LogLevel.warn
• LogLevel.error
• LogLevel.fatal
• LogLevel.off

This enum can be used to configure the logging level of the Momento package. By default, the logging level is set to LogLevel.info. To change the logging level, pass the desired level to the Configuration constructor:

var config = Mobile.latest(logLevel: LogLevel.debug);

Developing

If you are interested in contributing to the SDK, please see the CONTRIBUTING docs.

{{ ossFooter }}