README.md

[![CI](https://github.com/dart-lang/leak_tracker/actions/workflows/ci.yaml/badge.svg)](https://github.com/dart-lang/leak_tracker/actions/workflows/ci.yaml)
[![pub package](https://img.shields.io/pub/v/leak_tracker.svg)](https://pub.dev/packages/leak_tracker)
[![package publisher](https://img.shields.io/pub/publisher/leak_tracker.svg)](https://pub.dev/packages/leak_tracker/publisher)

Coming soon! See https://github.com/flutter/devtools/issues/3951 and
https://github.com/flutter/devtools/issues/5606.

## Memory Leak Tracker

TODO: The text below is under construction.

This is a framework for detecting memory issues in Dart and Flutter
applications. It enables:

1. [Memory leak auto-detection](doc/DETECT.md) for applications and tests.
2. [Memory usage tracking and auto-snapshotting](doc/USAGE.md).

Documentation:
1. [Understand leak tracking concepts](doc/CONCEPTS.md)
2. [Troubleshoot memory leaks](doc/TROUBLESHOOT.md)