aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCody Logan <clpo13@gmail.com>2021-12-07 15:30:18 -0800
committerCody Logan <clpo13@gmail.com>2021-12-07 15:30:18 -0800
commit3e57a1902f7bf6884662fb2aca403e13787c2d26 (patch)
tree5767a4564c42fa7e31d2523198b2e9acd50caaea
parent10268e7a76dfe72063d682e6043891b967cbad39 (diff)
downloadwikiget-3e57a1902f7bf6884662fb2aca403e13787c2d26.tar.gz
wikiget-3e57a1902f7bf6884662fb2aca403e13787c2d26.zip
Update README with logging info
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 575bb05..53061b6 100644
--- a/README.md
+++ b/README.md
@@ -33,8 +33,11 @@ access) are also supported with the use of the `--username` and `--password`
flags.
More detailed information, such as the site used and full URL of the file, can
-be displayed with `-v` or `--verbose`. Use `-vv` to display even more detail.
-`-q` can be used to silence warnings.
+be displayed with `-v` or `--verbose`. Use `-vv` to display even more detail,
+mainly debugging information or API messages. `-q` can be used to silence warnings.
+A logfile can be specified with `-l` or `--logfile`. If this option is present, the
+logfile will contain the same information as `-v` along with timestamps. New log
+entries will be appended to an existing logfile.
By default, the program won't overwrite existing files with the same name as the
target, but this can be forced with `-f` or `--force`. Additionally, the file
@@ -55,6 +58,7 @@ wikiget https://en.wikipedia.org/wiki/File:Example.jpg -o test.jpg
## Future plans
+- download multiple files at once in batch mode
- continue batch download even if input is malformed or file doesn't exist
(possibly by raising exceptions in `download()`)
- batch download by (Commons) category or user uploads
@@ -62,7 +66,7 @@ wikiget https://en.wikipedia.org/wiki/File:Example.jpg -o test.jpg
## Contributing
-Pull requests or bug reports are more than welcome.
+Pull requests, bug reports, or feature requests are more than welcome.
It's recommended that you use a
[virtual environment manager](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/)