max/chookchat
max/chookchat
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Update readme

Browse Source
This commit is contained in:
Maxwell Jeffress 2024-11-05 20:41:44 +11:00
parent a4b6721ebc
commit 61c60f7906
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -6,4 +6,22 @@ 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.
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)