Add a bit more to the README
- ID
1c98771- date
2024-05-17 06:42:31+00:00- author
Alex Chan <alex@alexwlchan.net>- parent
0059ab4- message
Add a bit more to the README- changed files
2 files, 9 additions
Changed files
.gitignore (19) → .gitignore (42)
diff --git a/.gitignore b/.gitignore
index d080851..197fbcd 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
*.pyc
*.webarchive
+save_safari_webarchive
README.md (1407) → README.md (1693)
diff --git a/README.md b/README.md
index f97907e..4024fa0 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,8 @@ This gives you an offline archive of web pages, which can be stored and backed u
$ save_safari_webarchive.swift "https://example.com" "example.webarchive"
```
+These archives are the same as those created by the `File > Save As…` menu item, but now you can create them programatically and in bulk.
+
## How it works
It opens the given URL in a `WKWebView`, calls `createWebArchiveData` to create a webarchive file, and saves it to disk.
@@ -20,6 +22,12 @@ For a more detailed explanation of this code, see <https://alexwlchan.net/2024/c
2. Download the `save_safari_webarchive.swift` script from this repo
3. Add the script somewhere in your PATH
+You may also want to compile the script into a binary, and add the binary to your PATH instead:
+
+```console
+$ swiftc save_safari_webarchive
+```
+
## Usage
Run the script passing two arguments: the URL you want to archive, and the path where you want to save the webarchive file.