From 177528cf60bcae83f6223c4e39d592ef1bc26b2f Mon Sep 17 00:00:00 2001 From: DcruBro Date: Sat, 29 Aug 2026 20:47:24 +0200 Subject: [PATCH] update readme --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fda3c78..fec86b1 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,18 @@ # Hammy - A Discord Bot for Ham/Amateur Radio Fun fact: The logo of Hammy is a function! It is: f(x) = e^(-x^2)sin(9x) +## Features +Currently in-development, many features planned! + +## Architecture +Hammy is written in C, using the [Concord Library](https://github.com/Cogmasters/concord). It's multithreaded, with a thread pool system for queuing jobs. + +User interactions can be of two types: +- Instant Interactions: Handled directly by the master thread, don't require any communication with the backend, performed on-bot. +- Non-Instant Interactions: Queued into the job pool, where a worker thread picks them up (handoff) for processing in the background and responds later. + ## AI Disclosure AI tools were used responsibly in the creation of this project, mainly for cmakelists off a pre-made template. It has also been used for minor things like functions, reviews, commits, etc. Contributors are responsible for their commits, regardless of the usage of AI or not.