From 44410f85f6956e9b7e792c80b1d001bd1dcc5c4c Mon Sep 17 00:00:00 2001 From: ITwrx Date: Sun, 18 May 2025 10:56:56 -0500 Subject: [PATCH] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 4043e2a..c066b12 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ #Forget-Me-Not + A single-user-per-instance web application for creating/editing Reminders that can repeat in various ways. Supports email and XMPP notifications. It is written in [Nim](https://nim-lng.org) using the [Guildenstern](https://github.com/olliNiinivaara/GuildenStern) multi-threaded server library and the muti-threaded [SQLiteral](https://github.com/olliNiinivaara/SQLiteral) SQLite API library. #System Package Dependencies + curl: send any due Reminders by running the following Curl command from /etc/periodic/15min or similar cron mechanism. -- curl -d "send_reminders_key=your-string-key" -X POST http://127.0.0.1:your-apps-post-port-num/send-reminders -- set your send_reminders_key in /post_handlers/send_reminders_post_handler.nim @@ -9,10 +11,12 @@ libsodium: This is used to hash user passwords when creating a Forget-Me-Not use sqlite3: for the database. nim: to compile binary. We used nim 2.2.4 at the time of writing this. #Compiling and running + -- Install any non std/lib Nim package dependencies imported in the Forget-Me-Not source code with Nimble. -- compile with `nim c --cc:clang --mm:atomicArc -d:ssl --d:release fmn_gs.nim`. Remove `--cc:clang` to use gcc instead. -- automate starting with openrc, systemd, or similar. -- use nginx (or similar) as reverse proxy and for serving assets. -- we will try to add some example configs for some of this as time allows, assuming user interest. #Or use ITwrx web hosted instance. + -- We will add a Forget-Me-Not project page to ITwrx.org along with hosting plan.