Update documentation for release v1.4.0

Former-commit-id: 25559878dca6f91567805473078398b7b6728126
Former-commit-id: 1f88fe4849e4f0d26d32fa69a772ca9863d53c42

share/doc/sshyp/changelog

@@ -1,48 +1,52 @@
-sshyp v1.3.0
+sshyp v1.4.0
 
-the serious shepherd update
+the argumentative agronomist update
 
-this release ties up many of sshyp's loose ends where there was
-room for major performance, compatibility, and security improvements
+this release overhauls sshyp's argument system and further streamlines
+the experience with optimizations and the removal of legacy features
 
 compatibility-breaking changes:
 
-- due to a near full re-write of the syncing functionality, all clients and servers
-must be updated to this release (v1.3.0 is not backwards compatible with any prior release)
-- it is recommended to either delete the contents of ~/.config/sshyp/deleted (on the server-side)
-or sync all of your clients before updating
-    ^ old entries in this folder will throw errors with v1.3.0
+- there are no technical breaking changes, but the UX has changed significantly due to the new argument system (detailed below)
 
 user-facing features:
 
-- none - all changes were under-the-hood - the user experience should be
-exactly the same as v1.2.0 - just faster, less buggy, and more secure
+- when typing an entry/folder name, it is now always the FIRST argument
+    ^ e.g. instead of "sshyp copy -p /example/test", it would now be "sshyp /example/test copy -p"
+    ^ this allows more easily editing the previous command to copy/edit a different field
+- better extension integration
+    ^ extensions can now ship with a config file that sshyp can use to call them from standard sshyp arguments
+    ^ the first extension supporting this is sshyp-mfa
+    ^ if sshyp-mfa v1.4.0.1+ is installed, "sshyp /example/test copy -m" will copy MFA keys to your clipboard
+- entry/folder names now MUST be specified as arguments
+    ^ there is no longer a separate input prompt if the entry/folder name is not provided as an argument
+    ^ the input prompt was a legacy feature from before arguments could specify entrys/folders with shell completion
+    ^ the entry list generated by entry_list_gen() is still present and can be viewed by running "sshyp" with no arguments
+- better Bash completions
+    ^ now correctly places backslashes to escape spaces in entry/folder names
+    ^ slightly faster than the previous iteration
+- IPv6 configuration support
 
-major fixes/optimizations:
+fixes/optimizations:
 
-- a near full re-write of the syncing functionality
-    ^ all syncing logic has been moved into sshync.py (from sshyp.py and sshypRemote.py)
-    ^ in my setup, a dry, local "sshyp sync" went from 2.00+ seconds (v1.2.0) to 0.36 seconds (v1.3.0)
-        ^ the performance improvements are even greater when syncing from outside your local network
-- the following character sequences will no longer break the syncing logic: "@", "^&*", and "*&^"
-    ^ ASCII separator characters 29-31 are now used, instead
-- os.system has been replaced with subprocess.run in all cases, shell=True is no longer used with subprocess.run
-    ^ this protects against shell escape attacks and potentially makes sshyp more compatible with some environments
-- replaced shell commands with python built-in library functions where applicable
-    ^ this brings speed and compatibility improvements
-- sshyp should no longer incorrectly assume an X11 environment when Wayland is in use
-    ^ this fixes clipboard support in some Wayland environments, such as Sway (Plasma/Gnome/Phosh were unaffected)
-- sshyp now uses the default pinentry on Haiku thanks to haikuports/haikuports#7457
-    ^ this brings the Haiku port in-line with the other sshyp packages in terms of security
-- "python3" is now called over ssh, rather than "python"
-    ^ some environments do not have a "python" symlink, or it links to "python2" - changing this increases compatibility
-- fixed an issue from v1.2.0 where renaming threw an error if not in offline mode
+- replaced "+=" with ".append" when extending lists to prevent creating an additional list
+- optimized usage of "str.split()" and replaced it with "str.splitlines()" where applicable
+- more concise "if... in ()" syntax replaces long "if" statement chains
+- lists have been substituted with tuples where applicable
+- entry_list_gen() has been re-written to be much smaller and faster
+- os.path is now used in place of pathlib.Path in areas where it is faster
+- the user's home directory is saved to a variable to prevent running expanduser() every time it is needed
 
 other notable changes:
 
-- quick-unlock password input is now hidden while the user is typing
-    ^ user input is now invisible to prevent snooping
-- lots of smaller optimizations not listed here
+- removed some uncommonly used, redundant arguments
+    ^ e.g. "-rm", "-s", "delete"
+    ^ their functionality was NOT removed, just their redundant arguments, since "shear", "sync", and "del" are the accepted syntax
+- errors containing entry/folder names reinforce correct syntax by adding leading/following slashes where necessary
+- thanks to pull request #25, there are new error messages for the read shortcut
+    ^ includes when no entry name is provided or the entry name only refers to a directory
+- directories provided in user input are no longer denoted by a following slash
+    ^ instead, os.path is used to determine if the user is referring to a file or directory
 
 <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>