<img alt="Pawnote: A purrfect API wrapper for PRONOTE" src="https://raw.githubusercontent.com/LiterateInk/Pawnote/index/.github/assets/banner.svg" width="100%" />

*This library **is not** affiliated with [Index-Education](https://www.index-education.com/) or [PRONOTE](https://www.index-education.com/fr/logiciel-gestion-vie-scolaire.php) in any way.*

## Installation

Use your favorite package manager to install this library from NPM.

```bash
# pnpm
pnpm add pawnote

# Yarn
yarn add pawnote

# npm
npm add pawnote

# Bun
bun add pawnote
```

## Documentation

You can find documentation with guides at [docs.literate.ink/pawnote](https://docs.literate.ink/pawnote).

If it's not enough you can also take a look at the [`examples`](https://github.com/LiterateInk/Pawnote/tree/js/examples) folder in the GitHub repository for inspiration.

If none of those are helpful, you can always [open an issue](https://github.com/LiterateInk/Pawnote/issues) to ask for help or join the [LiterateInk Discord server](https://literate.ink/discord).
