From dcbfcf067fb6d79201d60c701d51ad3a35b49ab2 Mon Sep 17 00:00:00 2001 From: "Mark A. Matney, Jr" Date: Tue, 12 Sep 2023 10:40:29 -0700 Subject: [PATCH] Update usage examples in README (#56) This should have been included with #52. --- src/main/scripts/import-items/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/main/scripts/import-items/README.md b/src/main/scripts/import-items/README.md index 8f6bda2..98ddd7c 100644 --- a/src/main/scripts/import-items/README.md +++ b/src/main/scripts/import-items/README.md @@ -30,7 +30,15 @@ PATH=$PATH:$HOME/path/to/UCLALibrary/hauth/src/main/scripts/import-items ## Example usage -Assuming that all CSV files in the current working directory contain open access items, and a Hauth instance is running at http://example.com: +When every item in each CSV file has a `Visibility` value, usage will look something like this: + +```bash +./import-items.py --api-key=0123456789ABCDEF http://example.com *.csv +``` + +where http://example.com is the base URL of the Hauth service. + +To import every item in each CSV file with a particular access mode (ignoring the `Visibility` column), the `--access-mode` flag is available as a sort of "override": ```bash ./import-items.py --api-key=0123456789ABCDEF --access-mode=OPEN http://example.com *.csv