chookchat/README.md

9 lines
844 B
Markdown
Raw Normal View History

2024-10-20 16:05:21 +11:00
# Chookpen - A simple messaging service
2024-10-16 08:29:12 +11:00
2024-10-20 16:05:21 +11:00
## What is Chookpen?
2024-11-05 20:18:43 +11:00
Chookpen is a lightweight, secure-ish chat server implementation focused on simplicity and real-time communication. It features user authentication, persistent message history, real-time updates via WebSockets, and supports both traditional HTTP endpoints and WebSocket connections for flexible integration. It uses very little resources on a system, often using a maximum of 20mb. Chookpen is BETA SOFTWARE, and MAY BE BUGGY! Don't expect too much.
2024-10-20 16:05:21 +11:00
2024-11-05 20:18:43 +11:00
## A guide to this repository
2024-10-20 16:05:21 +11:00
2024-11-05 20:18:43 +11:00
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.