From 76d2c4052bfa63fb965b105c46ae57189b281797 Mon Sep 17 00:00:00 2001 From: Mikkel ALMONTE--RINGAUD Date: Mon, 5 Aug 2024 05:08:12 +0200 Subject: [PATCH] docs: add more to README --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4d85209..634f8f3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,11 @@ -# Crowous +Crowous Banner -## License +*This library **is not** affiliated with [Les Crous](https://www.lescrous.fr/) in any way.* -This project is licensed under the GPL-3.0 License - see the [LICENSE](LICENSE) file for details. +## Documentation + +You can find documentation with guides at [docs.literate.ink/crowous](https://docs.literate.ink/crowous). + +If it's not enough you can also take a look at the [`examples`](https://github.com/LiterateInk/Crowous/tree/rust/examples) folder in the GitHub repository for inspiration. + +If none of those are helpful, you can always [open an issue](https://github.com/LiterateInk/Crowous/issues) to ask for help or join the [LiterateInk Discord server](https://literate.ink/discord).