Update README

[wksantiago]

Summary by CodeRabbit

• Documentation
  • Renamed title and expanded project overview to describe Keep as a FROST threshold signer with NIP-55/NIP-46 support and per-app policies.
  • Reorganized README with centered badges, Download, Usage, Building, and Contributing sections.
  • Expanded features list (multi-account, share import/export, background signing, audit log, biometrics/PIN, hardware-backed storage, proxy support).
  • Adjusted license presentation and contributor guidance.

[coderabbitai]

Warning

Rate limit exceeded

@wksantiago has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 5 minutes and 7 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Walkthrough

README.md title, branding, structure, and content were updated: expanded description to "Keep: FROST threshold signer for Android", reorganized sections (Download, Usage, Building/Development, Contributing), and a much-expanded feature list and documentation layout including NIP-55/NIP-46 and security/operational details.

Changes

Cohort / File(s)

Summary

README Documentation README.md

Title changed to "Keep: FROST threshold signer for Android"; expanded description and features (NIP-55 intents/content provider, NIP-46 remote signing, FROST share import/export, multi-account, per-app policies, background signing/rate limits, biometric/PIN, hardware-backed storage, certificate pinning, kill switch, SOCKS/Tor proxy, signing history); added centered badge row and download link, reorganized sections (Download, Usage, Building), renamed Development→Building, added Contributing with licensing note, adjusted license placement.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐇 I hopped through README lines with care,
Badges bright and features rare,
FROST and NIPs now sing in tune,
Keys split safe beneath the moon,
This rabbit cheers — documentation's fair!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title is vague and generic, using a non-descriptive term that doesn't convey meaningful information about the substantial changes to the README.	Use a more specific title that highlights the main change, such as 'Add comprehensive FROST threshold signer documentation to README' or 'Expand README with FROST protocol features and usage guide'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch update-readme-file

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

README.md (1)

54-55: ⚠️ Potential issue | 🟡 Minor

Update Rust minimum version to 1.86+.

Line 54 specifies Rust 1.85+, but cargo-ndk 4.1.2 (current as of mid-2025) requires Rust 1.86 as its minimum supported version. Update to Rust 1.86+, Android NDK r29, cargo-ndk.

Consider adding links to official documentation (e.g., Rust platform-support/android, Android NDK changelog, and cargo-ndk repository) to help developers confirm current requirements.

🧹 Nitpick comments (2)

README.md (2)

12-49: Use a single H1; demote section headers to H2.
Multiple # headers flatten the doc and break hierarchy/TOC rendering. Consider ## for sections like Features/Download/Usage/Building/Contributing/License.

Also applies to: 63-69

---

32-33: Use a Shields.io badge instead of relying on a third‑party image asset.

The badge image is pulled from an external repository (machiav3lli/oandbackupx), which creates a maintenance risk if it changes or becomes unavailable. Replace it with the Shields.io GitHub download badge, which is the industry-standard approach:

[![Downloads](https://img.shields.io/github/downloads/privkeyio/keep-android/total)](https://github.com/privkeyio/keep-android/releases)

This provides a dynamic badge that automatically reflects your project's download count without external image dependencies.

[coderabbitai]

Actionable comments posted: 2

🤖 Fix all issues with AI agents

In `@README.md`:
- Around line 34-35: The README currently embeds an image using the external URL
"https://github.com/machiav3lli/oandbackupx/raw/034b226cea5c1b30eb4f6a6f313e4dadcbb0ece4/badge_github.png"
which creates a brittle dependency; update the markdown line that contains that
image link by either 1) moving the badge file into this repo (add the image to
the repository and point the README image src to the repo's raw URL), 2)
replacing it with a shields.io-generated badge URL, or 3) using GitHub's native
release badge; modify the single markdown link line in README.md accordingly so
the image is served from a reliable source.
- Line 41: The README's Supported NIP-55 operations line is missing three
operations from the spec; update the list to include the full set by adding
`nip04_encrypt`, `nip04_decrypt`, and `decrypt_zap_event` alongside the existing
`get_public_key`, `sign_event`, `nip44_encrypt`, and `nip44_decrypt` so the
README reflects all seven supported NIP-55 operations.

🧹 Nitpick comments (1)

README.md (1)

59-59: Clarify the directory structure assumption.

The instruction to clone to ../keep assumes a specific directory layout that may not work for all development setups. Consider providing more flexible guidance or explaining why this structure is required.

📝 Suggested clarification

-# Clone keep workspace
-git clone https://github.com/privkeyio/keep ../keep
+# Clone keep workspace (must be sibling to keep-android directory)
+# Example: if keep-android is at ~/projects/keep-android, clone to ~/projects/keep
+git clone https://github.com/privkeyio/keep ../keep
+
+# Or specify a custom location using KEEP_REPO:
+# git clone https://github.com/privkeyio/keep /path/to/keep
+# KEEP_REPO=/path/to/keep ./build-rust.sh