apkg-reader/README.md

a library for reading your APKG files in JavaScript

# APKG Reader

JavaScript library for reading the [APKG][0] format.

# What is an APKG file?
> An APKG file is a custom deck of flashcards created for use in Anki, a flashcard-based studying program. It contains HTML data used for card presentation as well as text, images, and sounds. Users can create their own Anki flashcard decks or import others' by selecting the Create Deck or Get Shared buttons found in the app.
[Source][0]

## Usage

```ts
import { readDatabaseFrom, ZipHandler } from "apkg-reader.js";

const data =  new ZipHandler("path/to/apkg")
const db = await readDatabaseFrom(data);
```

[0]: https://fileinfo.com/extension/apkg#:~:text=An%20APKG%20file%20is%20a,text%2C%20images%2C%20and%20sounds.