new-doxa-monorepo

doxa-secret/README_EN.md

@@ -0,0 +1,92 @@
+# **DOXA secret**
+
+**DOXA secret** is a minimalist, local-first command-line tool for encrypting and protecting your secret messages. It allows you to convert messages into a custom alphabet defined in JSON format. Each character in the message is converted to a unique 5-character code, ensuring your privacy.
+
+The application is written in Go and offers an intuitive Terminal User Interface (TUI) powered by Charm's Bubble Tea.
+
+> [!IMPORTANT]
+> **Compatibility and Diacritics:** To ensure 100% compatibility across different platforms and encodings, the application only operates on basic Latin characters (without diacritics). All Czech accents (e.g. carons and acute accents) are automatically normalized during encryption (e.g. "ž" becomes "z", "á" becomes "a"). Spaces, commas, periods, and newlines are fully encrypted and will be perfectly visible in their original form after decryption.
+
+---
+
+## **Prerequisites**
+
+Before installing, make sure you have **Go** installed on your system (version 1.20 or higher is recommended). You can download Go from the official website: [https://go.dev/doc/install](https://go.dev/doc/install)
+
+---
+
+## **Installation**
+
+To install DOXA secret on your system, follow these steps:
+
+```bash
+git clone https://codeberg.org/Kankys/doxa-secret.git
+cd doxa-secret
+chmod +x install.sh
+./install.sh
+```
+
+The installation script will:
+* Check for Go presence on your system.
+* Download necessary dependencies (Bubble Tea, Lip Gloss, etc.).
+* Compile the application.
+* Move the executable `doxa-secret` to `$HOME/.local/bin/`.
+* Create the configuration directory `~/.doxa-secret/` and a default cipher `default.json`.
+
+**Adding to PATH (if necessary):**  
+If the command is not recognized after installation, add the following line to your shell profile (e.g., `~/.bashrc`, `~/.zshrc`):
+```bash
+export PATH=$PATH:$HOME/.local/bin
+```
+Then restart your terminal or reload the profile using `source ~/.bashrc`.
+
+### **Post-Installation Cleanup**
+Once the installation is successfully completed, you can safely remove the cloned repository directory:
+```bash
+rm -rf doxa-secret
+```
+
+---
+
+## **Message Organization (Import & Export)**
+
+For better organization, the application interacts with two main folders in your home directory:
+* **`~/doxa-secret/export/`** – This is where your newly written and encrypted messages (`.txt`) are automatically saved.
+* **`~/doxa-secret/import/`** – Place the encrypted messages received from other users here if you want to decrypt and read them in the application.
+
+---
+
+## **Cipher Configuration**
+
+Encryption rules are defined in JSON files inside the configuration directory `~/.doxa-secret/`. You can create multiple named ciphers and switch between them inside the TUI.
+Example alphabet structure (all codes must be exactly 5 characters long):
+
+```json
+{
+  "version": "1.0",
+  "mappings": {
+    " ": "k9#pA",
+    ",": "L5z2M",
+    ".": "q7R1o",
+    "a": "H3nK9",
+    "b": "8vX1m"
+  }
+}
+```
+
+---
+
+## **Usage**
+
+After installation, simply run it from any directory with:
+```bash
+doxa-secret
+```
+Press the `l` key in the main menu to toggle the interface language between Czech and English. For detailed information on usage and keyboard shortcuts, please refer to the [User Manual (MANUAL.md)](file:///home/kankys/Repos/Codeberg/doxa-secret/MANUAL.md).
+
+---
+
+## **License**
+
+This application is open-source and licensed under the MIT License.
+> *"Hiding secrets behind the facade of common appearance is the first step to protecting inner peace."*