From 3eadc9e17b2e57ed41a8505436b318980bbf9159 Mon Sep 17 00:00:00 2001
From: Brian Wo <45139213+brainwo@users.noreply.github.com>
Date: Mon, 19 Aug 2024 03:15:03 +0800
Subject: [PATCH] Add library documentation

Signed-off-by: Brian Wo <45139213+brainwo@users.noreply.github.com>
---
 lib/kara.dart | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/lib/kara.dart b/lib/kara.dart
index f57408f..c5178b4 100644
--- a/lib/kara.dart
+++ b/lib/kara.dart
@@ -2,6 +2,19 @@
 // Use of this source code is governed by a BSD-style license that can be found
 // in LICENSE or at https://opensource.org/license/BSD-3-clause.
 
+/// KARA (karaoke caption format) parser library.
+/// More info about KARA: https://github.com/libkara
+///
+/// # Parsing KARA file
+/// ```dart
+/// import 'dart:io';
+/// import 'package:kara/kara.dart';
+///
+/// Future<void> main() async {
+///   final karaFile = await File('example.kara');
+///   parse(karaFile);
+/// }
+/// ```
 library kara;
 
 import 'package:kara/src/exception.dart';