Skip to content

Commit 3eadc9e

Browse files
committed
Add library documentation
Signed-off-by: Brian Wo <[email protected]>
1 parent 8a1a168 commit 3eadc9e

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

lib/kara.dart

+13
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22
// Use of this source code is governed by a BSD-style license that can be found
33
// in LICENSE or at https://opensource.org/license/BSD-3-clause.
44

5+
/// KARA (karaoke caption format) parser library.
6+
/// More info about KARA: https://github.com/libkara
7+
///
8+
/// # Parsing KARA file
9+
/// ```dart
10+
/// import 'dart:io';
11+
/// import 'package:kara/kara.dart';
12+
///
13+
/// Future<void> main() async {
14+
/// final karaFile = await File('example.kara');
15+
/// parse(karaFile);
16+
/// }
17+
/// ```
518
library kara;
619

720
import 'package:kara/src/exception.dart';

0 commit comments

Comments
 (0)