Skip to content

docs: modernize README with current features and updated references#3761

Merged
aterga merged 1 commit intomainfrom
arshavir/keen-saha
Apr 7, 2026
Merged

docs: modernize README with current features and updated references#3761
aterga merged 1 commit intomainfrom
arshavir/keen-saha

Conversation

@aterga
Copy link
Copy Markdown
Collaborator

@aterga aterga commented Apr 5, 2026

Changes

  • Updated introduction to highlight current authentication methods (passkeys and OpenID Connect)
  • Replaced outdated dapp examples with current ones (OISY, Caffeine, NNS Dapp, OpenChat)
  • Clarified architecture: now explains two-canister setup (backend and frontend)
  • Enhanced feature descriptions with modern terminology and capabilities
  • Added new sections: "Key Features" and "Technology Stack"
  • Added "Contributing" section with links to CONTRIBUTING.md and HACKING.md
  • Updated documentation links to current developer docs
  • Removed outdated references and YouTube links
  • Improved table of contents with new sections

Summary

Comprehensive README modernization to reflect current Internet Identity features, architecture, and best practices for integration.

The README hadn't been updated since ~2021-2022. This refreshes it to
reflect the current state of Internet Identity: passkeys terminology,
OpenID Connect (Google/Apple/Microsoft), multiple accounts, discoverable
passkeys, two-canister architecture, and updated dapp examples. Removes
outdated references (Genesis Event video, Kyle Peacock blog, Distrikt/DSCVR)
and adds Key Features, Technology Stack, and Contributing sections.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@aterga aterga requested a review from a team as a code owner April 5, 2026 13:05
Copilot AI review requested due to automatic review settings April 5, 2026 13:05
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Modernizes the repository README to reflect current Internet Identity capabilities (passkeys + OpenID Connect), updated example dapps, and the current two-canister architecture, while adding contributor and stack information for developers integrating or working on II.

Changes:

  • Refreshes the introduction and feature bullets to include passkeys and OpenID Connect and updates example dapps/links.
  • Updates the architecture description to the current backend+frontend canister model and removes outdated presentation links.
  • Adds new “Key Features”, “Technology Stack”, and “Contributing” sections and updates the table of contents accordingly.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@aterga aterga added this pull request to the merge queue Apr 7, 2026
Merged via the queue into main with commit cb2212a Apr 7, 2026
52 checks passed
@aterga aterga deleted the arshavir/keen-saha branch April 7, 2026 15:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants