Add vitepress docs

This commit is contained in:
Ticruz
2025-02-04 14:43:40 +01:00
committed by Jon Staab
parent 43255bcb74
commit 94375a56ec
84 changed files with 10821 additions and 139 deletions
+19
View File
@@ -0,0 +1,19 @@
# @welshman/feeds
A powerful package for building and executing dynamic Nostr feeds.
It provides a declarative way to define complex feed compositions using set operations (union, intersection, difference) and various filtering mechanisms.
## What's Included
- **Feed Core** - Declarative feed definition with composable operations
- **Feed Compiler** - Transforms feed definitions into optimized relay requests
- **Feed Controller** - Manages feed execution and event loading
- **Feed Utils** - Helper functions for creating and manipulating feeds
- **Feed Types** - Supports authors, kinds, tags, DVMs, lists, WOT, and more
## Installation
```bash
npm install @welshman/feeds
```