You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
mleku 27f92336ae
Add NDK skill documentation and examples
2 months ago
..
examples Add NDK skill documentation and examples 2 months ago
INDEX.md Add NDK skill documentation and examples 2 months ago
README.md Add NDK skill documentation and examples 2 months ago
ndk-skill.md Add NDK skill documentation and examples 2 months ago
quick-reference.md Add NDK skill documentation and examples 2 months ago
troubleshooting.md Add NDK skill documentation and examples 2 months ago

README.md

NDK (Nostr Development Kit) Claude Skill

This skill provides comprehensive knowledge about working with the Nostr Development Kit (NDK) library.

Files

  • ndk-skill.md - Complete reference documentation with patterns from production usage
  • quick-reference.md - Quick lookup guide for common NDK tasks
  • examples/ - Code examples extracted from the Plebeian Market codebase

Usage

When working with NDK-related code, reference these documents to:

  • Understand initialization patterns
  • Learn authentication flows (NIP-07, NIP-46, private keys)
  • Implement event creation and publishing
  • Set up subscriptions for real-time updates
  • Query events with filters
  • Handle users and profiles
  • Integrate with TanStack Query

Key Topics Covered

  1. NDK Initialization & Configuration
  2. Authentication & Signers
  3. Event Creation & Publishing
  4. Querying Events
  5. Real-time Subscriptions
  6. User & Profile Management
  7. Tag Handling
  8. Replaceable Events
  9. Relay Management
  10. Integration with React/TanStack Query
  11. Error Handling & Best Practices
  12. Performance Optimization

All examples are based on real production code from the Plebeian Market application.