welshman/docs/getting-started.md

Getting Started

Welshman is modular - install only what you need:

# Core nostr utilities (events, filters, tags)
npm i @welshman/util

# In-memory event store and relay adapter
npm i @welshman/relay

# Networking and relay management
npm i @welshman/net

# Content parsing and rendering
npm i @welshman/content

# Event signing and encryption
npm i @welshman/signer

# Dynamic feed compilation
npm i @welshman/feeds

# Svelte stores and state management
npm i @welshman/store

# Full application framework (requires Svelte)
npm i @welshman/app

# Rich text editor component (requires Svelte)
npm i @welshman/editor

Choose packages based on your needs:

• Building a conventional client? Use the framework:

  npm i @welshman/app
  

• Prefer to put things together yourself? Start with:

  npm i @welshman/util @welshman/net @welshman/signer
  

• Just parsing and rendering content? Include:

  npm i @welshman/content
  

Each package is independent but integrates seamlessly. All packages are framework-agnostic, but work best with Svelte.