trackslash
VAULT-97 P2 For an agent

Bring the README and the GitHub project description up to date

0
All issues

Description

The README's intro and feature list predate most of the app. It's missing:

  • recovery phrases;
  • locked and encrypted items;
  • hidden items;
  • AutoFill, widgets and Spotlight;
  • device transfer;
  • the clipboard, keyboard and Hide While Recording protections;
  • that there's no network use or analytics.

The duress features are one bullet. "How to use Vault" has typos ("There's a few", "whereever"), and it runs down another app's backup instead of saying what Vault does.

The GitHub repo's About says only "2FA and secret vault with offline encrypted backups". It has no website link and no topics, so the repo is hard to find.

Change

README:

  • A clear opening: what Vault is, who it's for, and that it's offline and open source.
  • A features section grouped as the app is:
    • codes;
    • notes and recovery phrases;
    • when you're forced to unlock it;
    • backups;
    • privacy.
  • Claims kept to docs/security-model.md, linking to it for the limits.
  • The tenets, development tenets, Security, Contributing, Validation and Issues sections are kept, fixing only what's wrong in them.

GitHub About:

  • A description matching the README's first line.
  • The website, https://badbundle.com/apps/vault.
  • Topics: ios, swift, swiftui, 2fa, authenticator, totp, hotp, otp, encryption, privacy, offline-first, backup, duress, plausible-deniability, secure-notes, iphone, ipad.

Done when

The README describes the app as it is, and the repo's About has the new description, website and topics.

Sub-issues

0

Linked issues

0

GitHub

0

No branches or pull requests linked.

Comments

1
Bradley

Done in https://github.com/badbundle/vault-app/pull/708 (merged as 5d28234e), and in the repo settings.

  • README: a new opening and "Who it's for", then features grouped as the app is (2FA codes, notes and recovery phrases, when you're forced to unlock it, backups, privacy), kept to docs/security-model.md and linking to it. The old "How to use Vault" is gone. "Development tenets" is its own section and names the UI tests. Security, Contributing, Validation and Issues are unchanged. make validate passed.
  • GitHub About:
    • Description: "Open-source iPhone and iPad app for 2FA codes, private notes and crypto recovery phrases. Fully offline, encrypted, and built for when you're forced to unlock it."
    • Website: https://badbundle.com/apps/vault
    • Topics: 2fa, authenticator, backup, duress, encryption, hotp, ios, ipad, iphone, offline-first, otp, plausible-deniability, privacy, secure-notes, swift, swiftui, totp.

The Trackslash VAULT project's own description is still just the GitHub link. The Trackslash tools can't edit project descriptions, so that's a manual change if wanted.