[taskinen]

Why

The README told users to clone the repository and go run main.go. For v1.0.0, users will install the program instead. This is the third and last PR before the release:

1. Prepare the binary for installing: version, example config, config location #43, the flags, version and config location;
2. Build release binaries with GoReleaser #44, GoReleaser builds;
3. this PR.

Merge it after #43 and #44: it documents their features. It must also be merged before the tag, because the release archives and pkg.go.dev show the tagged commit's README.

Changes

README.md only. The old "Setup" section becomes Installation:

• With Go: go install github.com/taskinen/mailboxzero@latest.
  • It needs Go 1.26+; Go 1.21+ downloads Go 1.26 by itself.
  • The program lands in $(go env GOPATH)/bin, which must be on PATH.
• Ready-built program:
  • Which archive to download, and checking it against checksums.txt (sha256sum or shasum --ignore-missing -c; checked on macOS).
  • What the archive contains.
  • Allowing the unsigned program on macOS (xattr -d com.apple.quarantine, or Open Anyway) and Windows (SmartScreen).
• First Run: create ~/.config/mailboxzero/config.yaml with -example-config (with chmod 600, since it holds the token, plus PowerShell commands for Windows), add the token, start the program and open the page.
  • Also covers XDG_CONFIG_HOME and -config.
  • I checked that a config written by Windows PowerShell's > (UTF-16 with a byte-order mark) loads.
• Updating: run go install …@latest again, or download the new release. @v1.0.0 installs a particular version. -version and the page header show the version, and the release notes say what changed.

Also:

• The Getting Fastmail API Token steps stay.
• Mock mode becomes go run . -config config-mock.yaml.example.
• Enabling Real Changes and Configuration Options name the config file's location.
• A new "Config File Not Found" troubleshooting entry.
• Development: running from source (go run ., go build ., and why it's the package rather than main.go), plus GoReleaser and the version package in the project tree.

Checked

• No go run main.go, cp config… or go build … main.go remains.
• The section links (#first-run, #getting-fastmail-api-token, #enabling-real-changes) match their headings.
• The commands and archive names come from real runs: the GoReleaser snapshot build in Build release binaries with GoReleaser #44, and -example-config, -version and the missing-config message in Prepare the binary for installing: version, example config, config location #43.
• It merges cleanly with Prepare the binary for installing: version, example config, config location #43 and Build release binaries with GoReleaser #44.