From d6514605a7d72cd27aac1f07bb110fb9582df5a2 Mon Sep 17 00:00:00 2001 From: EquityBot <333319867+EquityBot@users.noreply.github.com> Date: Mon, 2 Nov 2026 12:03:52 +1100 Subject: [PATCH] docs(readme): add a first run, the nav line and the banner credit Add a First run section with clone and install steps and the expected start of `ghostsoap plan --pack start-here` (checked against a release build of main), so readers no longer start at `ghostsoap init` with no install step. Add the brand navigation line, credit the banner fonts (Cascadia Mono and Besley) and write '2 years' as a numeral. --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d557bed..96735ad 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ [![OpenSSF Scorecard](https://raw.githubusercontent.com/ryanduguid/.github/badges/EquityBot/GhostSoap.svg)](https://scorecard.dev/viewer/?uri=github.com/EquityBot/GhostSoap)
[![rust: 1.99+](.github/assets/badges/rust.svg)](https://www.rust-lang.org/) [![licence: FSL-1.1-ALv2](.github/assets/badges/licence.svg)](#licences) +[First run](#first-run) · [Using it](#using-it) · [With an AI agent](#with-an-ai-agent) · [Safety](#safety) · [What leaves your machine](#what-leaves-your-machine) · [Building](#building) · [Licences](#licences) + _GhostSoap at no Price._ @@ -21,6 +23,27 @@ GhostSoap is a free, local-first tool that helps people in Australia reclaim the **Status: milestone M2.** GhostSoap has a sourced [register](registry/README.md) of Australian entities and prepares request letters for you to send yourself. It does not yet track what you sent or the replies (milestone M3). The [plan](docs/plan.md) sets out what comes next. +## First run + +There is no prebuilt download yet, so you need [Git](https://git-scm.com/) and [Rust](https://rustup.rs/). This builds GhostSoap and shows what it would send. It needs none of your details and sends nothing. + +```bash +git clone https://github.com/EquityBot/GhostSoap +cd GhostSoap +cargo install --locked --path . +ghostsoap plan --pack start-here +``` + +You should see a list of businesses, each with how to contact it and what would be asked, starting with: + +```text +letter equifax-marketing-au by email to customercomplaintsAU@equifax.com + app7-no-marketing (APP 7.6(c), 7.7(a); a reasonable period, OAIC guide 30 days) + app7-no-facilitation (APP 7.6(d), 7.7(a); a reasonable period, OAIC guide 30 days) + app7-source (APP 7.6(e), 7.7(b); a reasonable period, OAIC guide 30 days) + details used: full name, email, phone, address +``` + ## Using it ```bash @@ -87,9 +110,11 @@ cargo build --release ## Licences -- Code: licensed under the Functional Source License, Version 1.1, ALv2 Future License (FSL-1.1-ALv2). You may use, modify and redistribute it for any purpose except a Competing Use as defined in LICENSE (making it available to others in a competing commercial product or service), and each version becomes available under Apache-2.0 two years after it is made available. See [LICENSE](LICENSE) and [NOTICE](NOTICE). +- Code: licensed under the Functional Source License, Version 1.1, ALv2 Future License (FSL-1.1-ALv2). You may use, modify and redistribute it for any purpose except a Competing Use as defined in LICENSE (making it available to others in a competing commercial product or service), and each version becomes available under Apache-2.0 2 years after it is made available. See [LICENSE](LICENSE) and [NOTICE](NOTICE). - Register and checklist data (`registry/` and, from milestone M4, `checklist/`): [CC0-1.0](LICENSE-DATA), so other privacy projects can reuse it. +The banner's lettering and emblem are drawn from Cascadia Mono and Besley glyphs (SIL OFL 1.1). + GhostSoap is not affiliated with, endorsed by or connected to Activision or the Call of Duty franchise. The name is a nod to it, nothing more. ---