docs: document options for static and live loader (#15)

* docs: adding jsdoc and updating README

* docs: document options for leafletLiveLoader

* docs: specify that a normal handle can be passed to loader options

* chore: changeset

.changeset/sweet-rockets-fetch.md

···
+---
+"@nulfrost/leaflet-loader-astro": patch
+---
+
+Add JSDoc comments for available loader options for leafletStaticLoader and leafletLiveLoader

README.md

···
 
 ## Usage
 
-### Build-time loader: leafletStaticLoader (recommended)
+<details>
+<summary>Build-time loader: leafletStaticLoader **(recommended)**</summary>
 
 ```ts
 // src/content.config.ts
···
 import { leafletStaticLoader } from "@nulfrost/leaflet-loader-astro";
 
 const documents = defineCollection({
-	loader: leafletStaticLoader({ repo: "did:plc:qttsv4e7pu2jl3ilanfgc3zn" }),
+	loader: leafletStaticLoader({ repo: "did:plc:qttsv4e7pu2jl3ilanfgc3zn" }), // or repo: dane.is.extraordinarily.cool
 });
 
 export const collections = { documents };
···
 
 <Content />
 ```
+</details>
 
-### Live loader: leafletLiveLoader
+<details>
+<summary>Live loader: leafletLiveLoader</summary>
 
 ```ts
 // astro.config.mjs
···
 import { leafletLiveLoader } from "@nulfrost/leaflet-loader-astro";
 
 const documents = defineLiveCollection({
-	loader: leafletLiveLoader({ repo: "did:plc:qttsv4e7pu2jl3ilanfgc3zn" }),
+	loader: leafletLiveLoader({ repo: "did:plc:qttsv4e7pu2jl3ilanfgc3zn" }), // or repo: dane.is.extraordinarily.cool
 });
 
 export const collections = { documents };
···
 
 <Content />
 ```
+
+</details>
+
+## Loader Options
+
+### Static Loader
+
+```ts
+leafletStaticLoader()
+```
+
+`repo`: This can be either your DID (did:plc:qttsv4e7pu2jl3ilanfgc3zn) or your handle (dane.is.extraordinarily.cool)
+
+`limit`: How many leaflet documents to return when calling `getCollection`. The default is 50 and the range is from 1 to 100.
+
+`reverse`: Whether or not to return the leaflet documents in reverse order. By default this is false.
+
+### Live Loader
+
+```ts
+leafletLiveLoader()
+```
+
+`repo`: This can be either your DID (did:plc:qttsv4e7pu2jl3ilanfgc3zn) or your handle (dane.is.extraordinarily.cool)
+
+> [!NOTE]
+> `getLiveCollection` supports a second argument where you can add additional filters, similar to the options you have access to for `leafletStaticLoader`
+
+```ts
+getLiveCollection()
+```
+
+`limit`: How many leaflet documents to return when calling `getCollection`. The default is 50 and the range is from 1 to 100.
+
+`reverse`: Whether or not to return the leaflet documents in reverse order. By default this is false.
+
 
 ## License
 

lib/leaftlet-static-loader.ts

···
 export function leafletStaticLoader(
 	options: StaticLeafletLoaderOptions,
 ): Loader {
-	const { repo, limit } = options;
+	const { repo, limit, reverse } = options;
 
 	if (!repo || typeof repo !== "string") {
 		throw new LiveLoaderError(
···
 							rpc,
 							repo,
 							cursor,
-							limit: 100,
+							reverse,
+							limit: 50,
 						});
 					for (const document of documents) {
 						if (limit && count >= limit) {

lib/types.ts

···
 
 export interface LiveLeafletLoaderOptions {
 	/**
-	 * @description Your repo is your DID (did:plc... or did:web...). You can find this information using: https://pdsls.dev
+	 * @description Your repo is your DID (did:plc... or did:web...) or handle (username.bsky.social). You can find this information using: https://pdsls.dev
 	 */
 	repo: string;
 }
 
 export interface StaticLeafletLoaderOptions {
 	/**
-	 * @description Your repo is your DID (did:plc... or did:web...). You can find this information using: https://pdsls.dev
+	 * @description Your repo is your DID (did:plc... or did:web...) or handle (username.bsky.social). You can find this information using: https://pdsls.dev
 	 */
 	repo: string;
-	filter?: string;
 	/**
+	 * @description The number of records leaflet records to return for getCollection, the default being 50. The range can be from 1 to 100.
 	 * @default 50
 	 */
 	limit?: number;
+	/**
+	 * @description Whether or not the records should be returned in reverse order.
+	 * @default undefined
+	 */
+	reverse?: boolean;
 }
 
 export interface LeafletDocumentRecord {

lib/utils.ts

···
 import type {} from "@atcute/atproto";
-import { type Handle, is } from "@atcute/lexicons";
+import { is } from "@atcute/lexicons";
 import { AtUri, UnicodeString } from "@atproto/api";
 import katex from "katex";
 import sanitizeHTML from "sanitize-html";