From ade2058f06e9a0b21704a511b1456f92781b0e1c Mon Sep 17 00:00:00 2001 From: Ersei Saggi Date: Sun, 4 Feb 2024 18:30:07 -0500 Subject: [PATCH] Some semblance of documentation --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9af400a --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +``` + _ _ _ _ _ _ _ +| | | |___| |___ ___ _____ ___ | |_ ___ | |_| |_ ___ +| | | | -_| | _| . | | -_| | _| . | | _| | -_| +|_____|___|_|___|___|_|_|_|___| |_| |___| |_| |_|_|___| + +oooooooooo. . +`888' `Y8b .o8 + 888 888 .ooooo. .ooooo. .o888oo + 888oooo888' d88' `88b d88' `88b 888 + 888 `88b 888ooo888 888ooo888 888 + 888 .88P 888 .o 888 .o 888 . +o888bood8P' `Y8bod8P' `Y8bod8P' "888" + +oooooooooo. .o8 +`888' `Y8b "888 + 888 888 .ooooo. .oooo. oooo d8b .oooo888 + 888oooo888' d88' `88b `P )88b `888""8P d88' `888 + 888 `88b 888 888 .oP"888 888 888 888 + 888 .88P 888 888 d8( 888 888 888 888 +o888bood8P' `Y8bod8P' `Y888""8o d888b `Y8bod88P +``` + +Requires a database. Defaults to SQLite, which should be all you need. + +Build with `cargo build --release`, and run the resulting binary. + +Connect to the server with `nc`, `telnet`, or your favourite network CLI program. + +There is no encryption, so beware! -- 2.45.2