From 1899ba35ca1c06dc50ab61c38262a8c642868c80 Mon Sep 17 00:00:00 2001 From: quenousimporte Date: Thu, 26 Oct 2023 10:30:29 +0200 Subject: [PATCH] update readme --- readme.md | 25 ++++++++++--------------- 1 file changed, 10 insertions(+), 15 deletions(-) diff --git a/readme.md b/readme.md index ab2a91d..7445ca3 100644 --- a/readme.md +++ b/readme.md @@ -6,26 +6,23 @@ Launch index.html from your web server or try https://notes.ouvaton.org. Your notes are stored in your browser local storage. +## Usage + +* command palette: ctrl+shift+p +* notes list: ctrl+p + ## Remote mode -You can use remote mode with your own php server to access your notes from the cloud. +You can use remote mode with your own php server to access your notes from the cloud: * put the source files on your php server * browse index.html * launch command "edit pgp keys" and paste your public and private keys as a single file (passphrase is not supported) * switch to remote mode: ctrl+shift+V -Your data file will never reach the server unencrypted. +Your data file will always be encrypted before reaching the server. -To protect your data file access by a password, edit settings.php and change `$password` variable. - -Your password will be sent from browser to server through a post http query with no more encryption than ssl, if enabled. Password is stored unencrypted in your browser local storage and in the settings.php file on server side. - -## Usage - -* help: f1 -* notes list: ctrl+p -* command palette: ctrl+shift+p +To protect your data file access by a password, edit settings.php and change `$password` variable. Your password will be sent from browser to server through a post http query, encrypted with ssl if enabled. It is stored unencrypted in your browser local storage and in the settings.php file on server side. ## Cli tool @@ -36,8 +33,6 @@ python3 app.py Requires python3, curl, gnupg and a text editor. -## Reclaim your data +## Export your data -Download your notes in a single json file with ctrl+shift+S. - -Dowload a zip file of your notes as markdown files with command "Download all notes in a zip file" +You can download your notes in a single json data file, or as flat markdown files in a zip archive.