Docs

CHANGELOG.md

@@ -1,3 +1,23 @@
+# 1.1.0
+
+- Fixed bug with --login and --password not being used
+- New command line option to ignore saved credentials
+- More documentation
+- Configurable ordered submission of uploads to Overcast server:
+
+Overcast used to order the `Uploads` feed by date of submission of the file to the Overcast server. 
+Because of this `cloudyuploader` submitted the uploaded files in strict order, otherwise they showed up in a mixed up.
+
+While I wasn't looking Marco changed the ordering of `Uploads` feed: now it's ordered by the file name.
+However, the upload date still is used in some places. It definitely controls the order of 
+[Recent Episodes](https://overcast.fm/podcasts) on the web, and may be used in playlist ordering (didn't check that).
+
+Because of that there's a new option `--unordered-submit`. It speeds up uploads somewhat, but file upload dates 
+become disordered.
+
+- Massive refactoring, now `cloudyuploader` resembles maintainable code.
+- Probably some new and exciting bugs. This is a homebrew automation project, not a properly structured application. Sorry 😔
+
 # 1.0.2
 
 - Nicer progress bar alignment
@@ -9,7 +29,7 @@
 # 1.0.0
 
 - Now storing passwords in secure platform-dependant storage (macOS Keychain, GNOME Keyring or Windows Credential Manager API)
-- Because of that cloudyuploader now saves your credentials by default
+- Because of that `cloudyuploader` now saves your credentials by default
 - Actually silence progress bars if -s is supplied
 - Various bugfixes
 

README.md

@@ -9,18 +9,49 @@ Sorry for the code quality, this is also my first go project. It works, whatever
 This project shouldn't cause any trouble, but I (of course) will shut it down if Marco isn't ok with it.
 
 ```
-Usage: cloudyuploader [--parallel-uploads N] [--save-creds] [--silent]
-                      [--login LOGIN] [--password PASSWORD] FILE [FILE ...]
+Usage: cloudyuploader [--login LOGIN] [--password PASSWORD] 
+                      [--save-creds] [--no-load-creds] [--silent] 
+                      [--parallel-uploads N] [--unordered-submit] FILE [FILE ...]
 
 Positional arguments:
   FILE                   files to be uploaded
 
 Options:
-  --parallel-uploads N, -j N
-                         maximum number of concurrent upload jobs [default: 4]
   --login LOGIN          email for Overcast account
   --password PASSWORD    password for Overcast account
-  --save-creds           save credentials in secure system storge [default: true]
+  --save-creds           save credentials in secure system storge
+  --no-load-creds        do not use stored creds
+  --parallel-uploads N, -j N
+                         maximum number of concurrent uploads [default: 4]
   --silent, -s           disable user interaction
+  --unordered-submit     don't wait to submit uploads in proper order
   --help, -h             display this help and exit
 ```
+
+## Authentication
+
+There are 3 ways to supply `cloudyuploader` with credentials. In order of priority:
+1. `--login` and `--password` command line arguments
+2. Credentials saved in secure system storage (macOS Keychain, GNOME Keyring or Windows Credential Manager API)
+3. Enter them interactively, when prompted
+
+You can prevent any of these methods:
+1. Don't supply `--login` and `--password` command line arguments
+2. Add `--no-load-creds`
+3. Add `--silent` (also disables all output, useful for scripting/automation)
+
+If you want to save the credentials to secure system storage:
+* Add `--save-creds` command line argument
+* You will be asked to save the credentials after a successful interactive login
+
+### Note for macOS users
+
+In order to save or read the credentials from the keychain it should be unlocked. Normally unlocking
+your mac is all that's needed, however, this doesn't extend to ssh logins. If you are connecting over ssh
+you should execute `security unlock-keychain` command prior to running `cloudyuploader`.
+
+`security unlock-keychain` could be automated, it accepts `-p PASSWORD` argument,
+but storing your keychain's (mac's) password in this way is really insecure.
+
+Your best bet is to supply Overcast `--login` and `--password` via the command line, they are less important
+than your main keychain password.