update doc with more features

icloud-photos-downloader · Jun 16, 2024 · 06ab9e7 · 06ab9e7
1 parent edff5a1
commit 06ab9e7
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 3 deletions.
diff --git a/docs/authentication.md b/docs/authentication.md
@@ -46,4 +46,21 @@ icloud --username jappleseed@apple.com --delete-from-keyring
 
 ```{note}
 Use `icloud`, not `icloudpd`
-```
+```
+
+## Password Providers
+
+```{versionadded} 1.20.0
+```
+
+Passwords for iCloud access can be supplied by user in three ways:
+- Using `--password` command line parameter
+- Using keyring
+- Using console
+
+It is possible to specify which of these three ways `icloudpd` should use, by specifying them with `--password-provider` parameter. More than one can be specified and the order
+of providers matches the order then will be checked for password. E.g. `--password-provider keyring --password-provider console` means that `icloudpd` will check password in keyring first and then, if no password found, ask for password in the console.
+
+Keyring password provider, if specified, saves valid password back into keyring.
+
+Default set and order of providers are: *parameter*, *keyring*, *console*
diff --git a/docs/mode.md b/docs/mode.md
@@ -1,5 +1,9 @@
 # Operation Modes
 
+```{versionchanged} 1.8.0
+Added `--delete-after-download` parameter
+```
+
 `icloudpd` works in one of three modes of operation:
 
 - **Copy** - download new photos from iCloud (default mode)

diff --git a/docs/naming.md b/docs/naming.md
@@ -4,13 +4,17 @@ Assets on iCloud have names. When downloading assets, `icloudpd` can adjust name
 
 ## Folder Structure
 
-`icloudpd` uses asset metadata (_created date_) to build folder hierarchy and it can be adjusted with `--folder-stucture` parameter.
+```{versionchanged} 1.7.0
+Support for `none` value added
+```
+
+`icloudpd` uses asset metadata (_created date_) to build folder hierarchy, and it can be adjusted with `--folder-stucture` parameter.
 
 Specifying `--folder-structure none` will put all files into one folder.
 
 ## Duplicates
 
-```{versionchanged} 1.19.0
+```{versionchanged} 1.20.0
 `--file-match-policy` parameter added and `name-id7` policy implemented
 ```
 

diff --git a/docs/size.md b/docs/size.md
@@ -2,6 +2,10 @@
 
 ## Basic Sizes
 
+```{versionchanged} 1.19.0
+Multiple `--size` parameters can be specified
+```
+
 Each asset in iCloud may have multiple sizes available for downloading:
 - original
 - medium