README.md

LogSnag

Installation 💻

❗ In order to start using Logsnag you must have the Dart SDK installed on your machine.

Add logsnag to your pubspec.yaml:

dependencies:
  logsnag: {version}

Install it:

dart pub get

---

Usage 🚀

Initialization

To initialize Logsnag, import the logsnag package and create a new instance of Logsnag:

import 'package:logsnag/logsnag.dart';

void main() {
  final logSnag = LogSnag(
    project: {project},
    token: {token},
  );
}

Logging

To send a log, use the log method:

logSnag.log(
  channel: 'test-channel',
  event: 'User Joined',
  description: 'Email: [email protected]',
  icon: '👋',
  tags: {
    'name': 'john doe',
    'email': '[email protected]',
  },
  notify: true,
);

Insight

To send an insight, use the insight method:

logSnag.insight(
  title: 'Test',
  value: 'Test',
  icon: '👋',
);