Update readme

This commit is contained in:
Maxwell Jeffress 2024-11-05 20:41:44 +11:00
parent a4b6721ebc
commit 61c60f7906

View File

@ -7,3 +7,21 @@ Chookpen is a lightweight, secure-ish chat server implementation focused on simp
## A guide to this repository
Chookpen is split up into multiple parts, the server and different reference clients for different platforms. For extensive documentation of all parts of Chookpen, a repository wiki is being worked on which will be released soon. For now, if you want to learn more about Chookpen, visit each folder.
## Acknowledgments
Chookpen relies on a lot of FOSS software, and wouldn't be possible without it! Here's some quick links to the original projects if you're interested:
### [Javalin](https://javalin.io)
An easy to use web server for Kotlin and Java. Chookpen wouldn't be possible without it!
### [Gradle](https://gradle.org)
The build tool for compiling Chookpen. It just works!
### [Kotlin](https://kotlinlang.org)
The language Chookpen is coded in. How else does it work?
### [OpenJDK](https://openjdk.org)