Add some notes to the README; initial version
- ID
aaa5919- date
2024-05-17 07:28:22+00:00- author
Alex Chan <alex@alexwlchan.net>- parent
66fd32d- message
Add some notes to the README; initial version- changed files
2 files, 19 additions, 23 deletions
Changed files
CHANGELOG.md (386) → CHANGELOG.md (54)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2f4b79e..7fdbe13 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,21 +1,5 @@
# CHANGELOG
-## v0.9.4 - 2024-05-17
+## v1.0.0 - 2024-05-17
-Trigger another release with GitHub Actions.
-
-## v0.9.3 - 2024-05-17
-
-Trigger another release with GitHub Actions.
-
-## v0.9.2 - 2024-05-17
-
-Trigger another release with GitHub Actions.
-
-## v0.9.1 - 2024-05-17
-
-Trigger another release with GitHub Actions.
-
-## v0.9.0 - 2024-05-17
-
-Initial release, to test deployment of binaries with GitHub Actions.
+Initial release.
README.md (1693) → README.md (2308)
diff --git a/README.md b/README.md
index 4024fa0..aacf443 100644
--- a/README.md
+++ b/README.md
@@ -18,15 +18,27 @@ For a more detailed explanation of this code, see <https://alexwlchan.net/2024/c
## Installation
+### Install from source
+
1. Install the Xcode Command Line Tools
2. Download the `save_safari_webarchive.swift` script from this repo
-3. Add the script somewhere in your PATH
+3. Compile the script into a binary:
-You may also want to compile the script into a binary, and add the binary to your PATH instead:
+ ```console
+ $ swiftc save_safari_webarchive.swift
+ ```
-```console
-$ swiftc save_safari_webarchive
-```
+4. Copy the compiled binary `save_safari_webarchive` to somewhere in your PATH.
+
+### Install a compiled binary
+
+1. Find the latest [GitHub release](https://github.com/alexwlchan/safari-webarchiver/releases)
+2. Download the zip file which is appropriate for your system (Intel = `x86_64`, Apple Silion = `aarch64`)
+3. Open the zip file, and add the `save_safari_webarchive` app to your PATH
+
+The app is just a compiled version of the Swift script.
+It isn't notarised, so when you run it, you may get a warning that this app is from an unidentified developer.
+You can get around this by right-clicking the app icon in Finder, and choosing `Open` from the shortcut menu.
## Usage