crowous/README.md

A wrapper for the Crous Mobile internal API.

<img alt="Crowous: A wrapper for the Crous Mobile internal API" src="https://raw.githubusercontent.com/LiterateInk/Crowous.js/main/.github/assets/banner.svg" width="100%" />

_This library **is not** affiliated with [Les Crous](https://www.lescrous.fr/) in any way._

## What is "Les Crous" ?

[Les Crous](https://www.lescrous.fr/) (or _Centres Régionaux des Œuvres Universitaires et Scolaires_) in France are regional organizations that provide various services to students to enhance their quality of life.

[Les Crous' mobile app](https://play.google.com/store/apps/details?id=com.einden.crous.poitiers.android) facilitates student life by providing access to housing applications, meal plan management, scholarship information, and various support services directly from their smartphones.

## Get Started

Jump right in by following the [**Installation Guide**](https://crowous.docs.literate.ink/guides/getting-started/installation/) to set things up.

Once in, explore annotated examples in the [**official documentation**](https://crowous.docs.literate.ink/guides/examples/) or check out the [`examples` folder on GitHub](https://github.com/LiterateInk/Crowous.js/tree/main/examples). You can also browse the full [**API Reference**](https://js.crowous.docs.literate.ink/) for details.

Still stuck ? [Open an issue](https://github.com/LiterateInk/Crowous.js/issues) or join the conversation on [Discord](https://literate.ink/discord) and ask for help in the appropriate channel.

## License

This project is licensed under the GPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details.