Cleanup
This commit is contained in:
23
README.md
23
README.md
@@ -73,12 +73,23 @@ properties of SNS:
|
||||
|
||||
SNS requires the identifier of a GPG public key for encryption to function.
|
||||
|
||||
**A word about encryption**: Enabling encryption will cause problems if
|
||||
previously un-encrypted notes exist. In the future, I'd like to resolve these,
|
||||
however for the time being it's best to decide when you install SNS if you'd
|
||||
like to enable encryption or not.
|
||||
**Encryption amendment**: As of SNS 2a10, experimental support is in place for
|
||||
migrating between encrypted and unencrypted note stores.
|
||||
* Version Control program
|
||||
SNS can be configured to use a version control program such as Git,
|
||||
Mercurial, Subversion, etc. When configured, SNS can pass commands through
|
||||
to the specified program in the context of SNS's store. For example, if Git
|
||||
was configured here, then `sns git init` would initialize a Git repository
|
||||
for your notes; `sns git remote add` could be used to add a remote repo, and
|
||||
`sns git push` could push committed changes to the notes store to that
|
||||
remote.
|
||||
|
||||
|
||||
**A word about encryption:**
|
||||
When editing an encrypted note, SNS will decrypt
|
||||
the note to a temporary file inside its store. The temporary file will have a
|
||||
random name, but a predictable location. It can only be read by the user and
|
||||
root, and is deleted after editing, but can be recovered by forensic utilities.
|
||||
SNS's encryption is mainly useful when the store is being _transferred over a
|
||||
network_.
|
||||
|
||||
## Tips and Tricks
|
||||
* To list all notes in all notebooks, use `sns -l .`
|
||||
|
||||
Reference in New Issue
Block a user