Expanded configuration section in readme

This commit is contained in:
Jon-William Lewis
2016-02-16 21:56:24 -06:00
parent 0d54ab7bc1
commit 7853cee63c

View File

@@ -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,