Skip to content

docs: add SDK-grade README for Next.js integration#1

Open
Clawue884 wants to merge 9 commits intopi-apps:mainfrom
Clawue884:main
Open

docs: add SDK-grade README for Next.js integration#1
Clawue884 wants to merge 9 commits intopi-apps:mainfrom
Clawue884:main

Conversation

@Clawue884
Copy link
Copy Markdown

Summary

This PR adds an SDK-grade README.md to improve developer onboarding and clarify how to integrate pi-sdk-nextjs with Next.js (App Router).

What’s included

  • Clear high-level overview of the SDK
  • Installation and environment variable setup
  • Minimal, secure Next.js App Router usage examples
  • Security model and design principles

Scope

  • Documentation only
  • No changes to core SDK logic, API, or behavior

Motivation

The project already provides a functional SDK and CLI, but a more structured README helps:

  • New developers understand the intended usage faster
  • Reduce integration errors around authentication callbacks
  • Improve overall adoption without impacting existing users

Notes

This PR intentionally avoids modifying any source code and focuses solely on documentation improvements.

Updated the README to clarify SDK purpose and usage.
Removed 'Salin kode' comments from code examples.
This document outlines the security model and best practices for integrating Pi Network authentication using pi-sdk-nextjs. It covers core principles, callback verification, client-side responsibilities, logging, payment event handling, threat model, and responsibility boundaries.
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.

1 participant