aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordakkar <dakkar@thenautilus.net>2024-12-19 09:57:42 +0000
committerdakkar <dakkar@thenautilus.net>2024-12-19 09:57:42 +0000
commit3132bce2a8166e3f9818059af4de8d69a09bbf12 (patch)
treee92a1cbb61dba41a4a2dcd99ed72babb480e8ccf /README.md
parentminimal example (diff)
downloadgo-example-3132bce2a8166e3f9818059af4de8d69a09bbf12.tar.gz
go-example-3132bce2a8166e3f9818059af4de8d69a09bbf12.tar.bz2
go-example-3132bce2a8166e3f9818059af4de8d69a09bbf12.zip
move more code in the factory
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index 78052d6..86dc307 100644
--- a/README.md
+++ b/README.md
@@ -23,5 +23,13 @@ also do `make lint` to get a linting / critique of all the source
files (`lint` runs `fmt` first, so you need to have installed the
packages above as well).
-Note that the `Makefile` is *for development*, it's not used on
-production machines.
+Note that the `Makefile` is *for development*, it's not used after the
+code is built.
+
+## Structure
+
+* the entry points go under `cmd/`, with a matching target in the
+ `Makefile`
+* the `factory` constructs all the singletons that actually do things
+ (e.g. listeners, models, clients, business logic objects)
+* the `config` handles all configuration for the entire application