From 05148b66bc79e59f48c6ab9dca5efa07da3605e6 Mon Sep 17 00:00:00 2001 From: 201st-Luka Date: Sun, 1 Oct 2023 15:15:48 +0200 Subject: [PATCH] feat: README.md update --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 23633ff..ea4b16e 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,14 @@ following command: pip install pyclasher ``` +## Documentation + +The documentation of this project is available on +[PyClasher's GitHub pages][pyclasher_doc]. + +> **_NOTE:_** The documentation is not fully completed yet. It is still in +> progress. + --- ## Features @@ -92,3 +100,4 @@ www.supercell.com/fan-content-policy. [discord_url]: https://discord.gg/j2PAF9Wru8 [last_commit_shield]: https://img.shields.io/github/last-commit/201st-Luka/HeadhunterBot [headhunterbot_url]: https://github.com/201st-Luka/HeadhunterBot +[pyclasher_doc]: https://201st-luka.github.io/PyClasher/