Updated README for SNS v2a

README.md

@@ -12,7 +12,7 @@ its own GUI editor and proprietary file format, but instead could use the tools
 already provided by the operating system.
 
 As it developed, OpenSSL encryption was dropped in favor of GPG, and the script
-was almost entirely rewritten as SNSv2.
+was almost entirely rewritten as SNSv2, and rewritten again as SNS v2a.
 
     simple note system
     ==================
@@ -30,57 +30,17 @@ was almost entirely rewritten as SNSv2.
 ## Installing
 
 ### Notice:
-If you are upgrading to SNS 2.0a11 from an earlier version, please move
+If you are upgrading to SNS v2a from an earlier version, please move
 $HOME/.config/sns to $HOME/.local/sns
 
-To install, place `sns.sh` in your path, and copy `src/bash-completion/sns`
+To install, place `sns.sh` in your path, 
-to `/usr/share/bash-completion/completions/sns`.
 
-Or simply run `./install.sh`.
+To uninstall, remove the files you copied. Notes will still exist in $HOME/.local/sns
 
-To uninstall, remove the files you copied, or run `./install.sh --uninstall`
+Once installed, SNS will require you to run `sns -i [gpgkey]`, to indicate you would like
-
-Once installed, SNS will require you to run `sns -i`, to indicate you would like
 to create its note store and write its default configuration.
 
-By default, SNS will set itself up in `~/.config/sns`, with `~/.config/sns/sns.conf`
+By default, SNS will set itself up in `~/.local/sns`
-as its configuration file.
-
-## Configuration
-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.
-
-* 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:**
@@ -95,16 +55,22 @@ network_.
 * To list all notes in all notebooks, use `sns -l .`
 
 ## Credits
-The majority of the code here is my own, however the bash completion
+The code here is my own, however much of SNS v2a's design and behavior was
-code comes from [pass], the standard UNIX package manager, along with some
+influenced by [pass].
-design and feature ideas.
 
 ## License
 Simple Note System is licensed under the terms of the GNU General Public License
 Version 2, as detailed in `LICENSE`.
 
-## Bugs
+## To Do
+* Switch back to calling $EDITOR instead of vim
+* implement in-place encryption (vim only)
+
+## Bugs and Feature Requests
 If something seems off, or just doesn't work, please open an issue and I'll look
 into it.
 
+Feature requests should be submitted to jon.lewis@xenami.net with [SNS Feature Request]
+in the subject line.
+
 [pass]: http://passwordstore.org