From 7853cee63c42f46336d9abe19949d51c07b68715 Mon Sep 17 00:00:00 2001 From: Jon-William Lewis Date: Tue, 16 Feb 2016 21:56:24 -0600 Subject: [PATCH] Expanded configuration section in readme --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2ef4b10..879831a 100644 --- a/README.md +++ b/README.md @@ -42,8 +42,31 @@ By default, SNS will set itself up in `~/.config/sns`, with `~/.config/sns/sns.c as its configuration file. ## Configuration -In SNS's configuration file, you can change the editor SNS uses, along with -the date format used in notes, and whether or not to use GPG encryption. +In the configuration file, `~/.config/sns/sns.conf` you can change the following +properties of SNS: + +* The file extension to use for notes + + The default is `.note`, however you might change it to `.md` for editor autodetection. + +* The editor SNS calls + + SNS will refuse to run if $EDITOR isn't specified by the environment, however you can + set an editor here separate from the environment-specified one. + +* Date Format + + SNS adds date and time to notes and edits by default. Clearing this should + remove the date/time line by default, but you can also change it to any + string the `date` command will accept as a format. + +* Encryption + + This is SNS's main encryption toggle. It must be on for encryption to function. + +* Public Key + + 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,