Skip to content

docs: add 30-second quick start and streamline README for easy onboarding#35

Merged
GalaxySciTech merged 1 commit into
masterfrom
codex
Apr 30, 2026
Merged

docs: add 30-second quick start and streamline README for easy onboarding#35
GalaxySciTech merged 1 commit into
masterfrom
codex

Conversation

@GalaxySciTech

Copy link
Copy Markdown
Owner

Motivation

  • Make first-run experience frictionless so a developer can install and get an address within seconds instead of reading long docs.
  • Reduce initial surface area and cognitive load by surfacing only the minimal steps required to generate and store an identity and derive a wallet.

Description

  • Rewrote README.md to add a prominent Quick Start (30 seconds) section with a minimal bootstrap snippet that uses WalletManager.storage = () -> new File("./keystore");, Identity.createIdentity(...), and identity.deriveWalletByMnemonics(...) so a user can copy-paste and get an address immediately.
  • Added a short Core Features (Recommended Minimum) section that recommends shipping only identity/keystore, a single chain (ETH or BTC), and offline signing for first release.
  • Simplified top navigation and deprioritized longer reference content (extended offline signing examples and contact info) to keep the first-use path concise.
  • This is a documentation-only change and does not modify runtime code.

Testing

  • Ran the test suite with ./gradlew test and the build completed successfully with all unit tests passing.

Codex Task

@GalaxySciTech GalaxySciTech merged commit 2c11142 into master Apr 30, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant