Add documentation

2024-12-13 14:16:38 -08:00
parent 627eb1e36d
commit f7baa54724
940 changed files with 4549 additions and 55 deletions
@@ -1,4 +1,4 @@
-# @welshman/feeds [![version](https://badgen.feeds/npm/v/@welshman/feeds)](https://npmjs.com/package/@welshman/feeds)
+# @welshman/feeds [![version](https://badgen.net/npm/v/@welshman/feeds)](https://npmjs.com/package/@welshman/feeds)

 A custom feed compiler and loader for nostr. Read the spec on [wikifreedia](https://wikifreedia.xyz/cip-01/97c70a44366a6535c1).

@@ -18,7 +18,7 @@ const feed = intersectionFeed(
  scopeFeed("global"),
 )

-// Create a controller
+// Create a controller, providing required context via FeedOptions
 const controller = new FeedController({
  feed,
  request,
@@ -30,5 +30,5 @@ const controller = new FeedController({
 })

 // Load notes using the feed
-controller.load(10)
+const events = await controller.load(10)
 ```
@@ -0,0 +1,3 @@
+{
+  "entryPoints": ["src/index.ts"]
+}