WIP

Author: functora

rust/cryptonote/README.md

@@ -1,42 +1,20 @@
-# Development
+# Cryptonote
 
-Your new jumpstart project includes basic organization with an organized `assets` folder and a `components` folder.
-If you chose to develop with the router feature, you will also have a `views` folder.
+Cryptonote is a cross-platform, fully offline application for creating, storing, and sharing encrypted notes. It is completely serverless and runs entirely on your device or in your web browser - no internet connection or external services are required.
 
-```
-project/
-├─ assets/ # Any assets that are used by the app should be placed here
-├─ src/
-│  ├─ main.rs # The entrypoint for the app. It also defines the routes for the app.
-│  ├─ components/
-│  │  ├─ mod.rs # Defines the components module
-│  │  ├─ hero.rs # The Hero component for use in the home page
-│  ├─ views/ # The views each route will render in the app.
-│  │  ├─ mod.rs # Defines the module for the views route and re-exports the components for each route
-│  │  ├─ blog.rs # The component that will render at the /blog/:id route
-│  │  ├─ home.rs # The component that will render at the / route
-├─ Cargo.toml # The Cargo.toml file defines the dependencies and feature flags for your project
-```
+With Cryptonote, you can:
 
-### Tailwind
-1. Install npm: https://docs.npmjs.com/downloading-and-installing-node-js-and-npm
-2. Install the Tailwind CSS CLI: https://tailwindcss.com/docs/installation
-3. Run the following command in the root of the project to start the Tailwind CSS compiler:
+- Write a short plain-text note
+- Optionally encrypt it using strong, well-established symmetric (e.g., AES-GCM, ChaCha20-Poly1305) or asymmetric algorithms (e.g., X25519 + AES-GCM hybrid)
+- Or leave it unencrypted
+- Share the note instantly via a URL or scannable QR code
 
-```bash
-npx tailwindcss -i ./tailwind.css -o ./assets/tailwind.css --watch
-```
+All content, including the ciphertext or plaintext, is embedded directly in the URL itself, making sharing as simple as sending a link or showing a QR code.
 
-### Serving Your App
+Cryptonote follows modern cryptographic best practices:
 
-Run the following command in the root of your project to start developing with the default platform:
-
-```bash
-dx serve
-```
-
-To run for a different platform, use the `--platform platform` flag. E.g.
-```bash
-dx serve --platform desktop
-```
+- Strong key derivation using HKDF
+- Authenticated encryption ensuring confidentiality, integrity, and authenticity
+- No data ever leaves your device unless you explicitly share it
 
+Secure, private, and truly offline - your notes stay yours.