chore: add project docs, readme, and UI mockup

2026-06-09 19:30:00 -04:00
parent 5e5ffaee3c
commit 9498cbb32b
4 changed files with 419 additions and 0 deletions
@@ -0,0 +1,27 @@
+* Noise
+
+Noise is a Signal Messenger client in Elisp for Emacs powered by https://github.com/AsamK/signal-cli
+
+Its ultimate goal is to provide a fast and efficient user interfae for Signal chats.
+
+** Tech stack
+The tech stack is Elisp and SQLite (for storing conversations)
+
+** Setup
+The project assumes a working installation of signal-cli and interfaces with that via JSON-RPC.
+
+** Dependencies
+
+For SQLite access we use this library - https://github.com/pekingduck/emacs-sqlite3-api
+
+We communicate with signal-cli via JSON-RPC over HTTP on localhost port 9128 by default but this can be configured by specifying =noise-signal-cli-address=
+
+** User Experience
+
+We follow Emacs conventions for keybindings with the addition of evil support out of the box. When evil compatibility is enabled then we provide a modal interface for searching conversations/contacts, creating conversations, sending messages, etc.
+
+** User Interface
+
+See the file signal-emacs-ui.html for user interface mockups we're targetting.
+
+