Skip to content

Commit

Permalink
Add library documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Brian Wo <45139213+brainwo@users.noreply.github.com>
  • Loading branch information
brainwo committed Aug 18, 2024
1 parent 8a1a168 commit 3eadc9e
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions lib/kara.dart
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down

0 comments on commit 3eadc9e

Please sign in to comment.