Commit 06485ac0 authored by ChanHaeng Lee's avatar ChanHaeng Lee
Browse files

Added docs

parent 1b1720e7

AGENTS.md

+8 −4
Original line number Diff line number Diff line
@@ -61,17 +61,21 @@ The repository is organized as a monorepo with the following packages: 
    -  *src/testing/*: Testing utilities

    -  *src/vocab/*: ActivityPub vocabulary implementation

    -  *src/webfinger/*: WebFinger protocol implementation

    -  *src/x/*: Framework integrations

    -  ~~src/x/: Framework integrations ~~ **Don't use.** This directory will be removed in version 2.0.0. Use *@fedify/{package name}*(*packages/{package name}*) packages.

 -  *packages/cli/*: Fedify CLI implementation (@fedify/cli, built with Deno)

 -  *packages/amqp/*: AMQP/RabbitMQ driver (@fedify/amqp)

 -  *packages/cfworkers/*: Cloudflare Workers integration (@fedify/cfworkers)

 -  *packages/denokv/*: Deno KV integration (@fedify/denokv)

 -  *packages/elysia/*: Elysia integration (@fedify/elysia)

 -  *packages/express/*: Express.js integration (@fedify/express)

 -  *packages/h3/*: h3 framework integration (@fedify/h3)

 -  *packages/hono/*: Hono integration (@fedify/hono)

 -  *packages/postgres/*: PostgreSQL drivers (@fedify/postgres)

 -  *packages/redis/*: Redis drivers (@fedify/redis)

 -  *packages/nestjs/*: NestJS integration (@fedify/nestjs)

 -  *packages/next/*: Next.js integration (@fedify/next)

 -  *packages/sqlite/*: SQLite driver (@fedify/sqlite)

 -  *packages/sveltekit/*: SvelteKit integration (@fedify/sveltekit)

 -  *packages/testing/*: Testing utilities (@fedify/testing)

 -  *docs/*: Documentation built with Node.js and VitePress

 -  *examples/*: Example projects demonstrating Fedify usage
@@ -143,10 +147,10 @@ Common Tasks 


### Implementing Framework Integrations



1. Add new integrations in the *packages/fedify/src/x/* directory

2. Follow pattern from existing integrations (hono.ts, sveltekit.ts)

1. Create a new package in *packages/* directory for new integrations

2. Follow pattern from existing integration packages (*packages/hono/*, *packages/sveltekit/*)

3. Use standard request/response interfaces for compatibility

4. Consider creating a dedicated package for substantial integrations

4. Consider creating example applications in *examples/* that demonstrate usage



### Creating Database Adapters

CHANGES.md

+42 −0
Original line number Diff line number Diff line
@@ -41,10 +41,21 @@ To be released. 
 -  Changed how `parseSoftware()` function handles non-Semantic Versioning

    number strings on `tryBestEffort` mode.  [[#353], [#365] by Hyeonseo Kim]]



 -  Separated modules from `@fedify/fedify/x` into dedicated packages to

    improve modularity and reduce bundle size.  The existing integration

    functions in `@fedify/fedify/x` are now deprecated and will be removed in

    version 2.0.0.  [[#375] by Chanhaeng Lee]



     -  Deprecated `@fedify/fedify/x/cfworkers` in favor of `@fedify/cfworkers`.

     -  Deprecated `@fedify/fedify/x/denokv` in favor of `@fedify/denokv`.

     -  Deprecated `@fedify/fedify/x/hono` in favor of `@fedify/hono`.

     -  Deprecated `@fedify/fedify/x/sveltekit` in favor of `@fedify/sveltekit`.



[FEP-5711]: https://w3id.org/fep/5711

[#353]: https://github.com/fedify-dev/fedify/issues/353

[#365]: https://github.com/fedify-dev/fedify/pull/365

[#373]: https://github.com/fedify-dev/fedify/issues/373

[#375]: https://github.com/fedify-dev/fedify/issues/375

[#381]: https://github.com/fedify-dev/fedify/pull/381



### @fedify/cli
@@ -67,6 +78,30 @@ To be released. 
[#353]: https://github.com/fedify-dev/fedify/issues/353

[#365]: https://github.com/fedify-dev/fedify/pull/365



### @fedify/cfworkers



 -  Created Cloudflare Workers integration as the *@fedify/cfworkers* package.

    Separated from `@fedify/fedify/x/cfworkers` to improve modularity and

    reduce bundle size.  [[#375] by Chanhaeng Lee]



[#375]: https://github.com/fedify-dev/fedify/issues/375



### @fedify/denokv



 -  Created Deno KV integration as the *@fedify/denokv* package.

    Separated from `@fedify/fedify/x/denokv` to improve modularity and

    reduce bundle size.  [[#375] by Chanhaeng Lee]



[#375]: https://github.com/fedify-dev/fedify/issues/375



### @fedify/hono



 -  Created Hono integration as the *@fedify/hono* package.

    Separated from `@fedify/fedify/x/hono` to improve modularity and

    reduce bundle size.  [[#375] by Chanhaeng Lee]



[#375]: https://github.com/fedify-dev/fedify/issues/375



### @fedify/next



 -  Created [Next.js] integration as the *@fedify/next* package.
@@ -82,6 +117,13 @@ To be released. 


[#368]: https://github.com/fedify-dev/fedify/pull/368



### @fedify/sveltekit



 -  Created SvelteKit integration as the *@fedify/sveltekit* package.

    Separated from `@fedify/fedify/x/sveltekit` to improve modularity and

    reduce bundle size.  [[#375] by Chanhaeng Lee]



[#375]: https://github.com/fedify-dev/fedify/issues/375



Version 1.8.5

-------------

CONTRIBUTING.md

+4 −0
Original line number Diff line number Diff line
@@ -191,14 +191,18 @@ The repository is organized as a monorepo with the following packages: 
 -  *packages/cli/*: The Fedify CLI (@fedify/cli).  The CLI is built with

    [Deno].

 -  *packages/amqp/*: AMQP/RabbitMQ driver (@fedify/amqp) for Fedify.

 -  *packages/cfworkers/*: Cloudflare Workers integration (@fedify/cfworkers) for Fedify.

 -  *packages/denokv/*: Deno KV integration (@fedify/denokv) for Fedify.

 -  *packages/elysia/*: Elysia integration (@fedify/elysia) for Fedify.

 -  *packages/express/*: Express integration (@fedify/express) for Fedify.

 -  *packages/h3/*: h3 framework integration (@fedify/h3) for Fedify.

 -  *packages/hono/*: Hono integration (@fedify/hono) for Fedify.

 -  *packages/postgres/*: PostgreSQL drivers (@fedify/postgres) for Fedify.

 -  *packages/redis/*: Redis drivers (@fedify/redis) for Fedify.

 -  *packages/nestjs/*: NestJS integration (@fedify/nestjs) for Fedify.

 -  *packages/next/*: Next.js integration (@fedify/next) for Fedify.

 -  *packages/sqlite/*: SQLite driver (@fedify/sqlite) for Fedify.

 -  *packages/sveltekit/*: SvelteKit integration (@fedify/sveltekit) for Fedify.

 -  *packages/testing/*: Testing utilities (@fedify/testing) for Fedify.

 -  *docs/*: The Fedify docs.  The docs are built with [Node.js] and

    [VitePress].

docs/manual/integration.md

+8 −0
Original line number Diff line number Diff line
@@ -125,6 +125,10 @@ Hono 


*This API is available since Fedify 0.6.0.*



> [!WARNING]

> The `@fedify/fedify/x/hono` module is deprecated and will be removed in

> Fedify 2.0.0.  Please use the `@fedify/hono` package instead.



[Hono] is a fast, lightweight, and Web standard-compliant server framework for

TypeScript.  Fedify has the `@fedify/fedify/x/hono` module that provides

a middleware to integrate Fedify with Hono:
@@ -244,6 +248,10 @@ SvelteKit 


*This API is available since Fedify 1.3.0.*



> [!WARNING]

> The `@fedify/fedify/x/sveltekit` module is deprecated and will be removed in

> Fedify 2.0.0.  Please use the `@fedify/sveltekit` package instead.



[SvelteKit] is a framework for building web applications with [Svelte].  Fedify

has the `@fedify/fedify/x/sveltekit` module that provides a hook handler to

integrate Fedify with SvelteKit.  Put the following code in your

docs/manual/kv.md

+8 −0
Original line number Diff line number Diff line
@@ -133,6 +133,10 @@ const federation = createFederation<void>({ 


### `DenoKvStore` (Deno only)



> [!WARNING]

> The `@fedify/fedify/x/deno` module is deprecated and will be removed in

> Fedify 2.0.0.  Please use the `@fedify/denokv` package instead.



`DenoKvStore` is a key–value store implementation for [Deno] runtime that uses

Deno's built-in [`Deno.openKv()`] API. It provides persistent storage and good

performance for Deno environments.  It's suitable for production use in Deno
@@ -280,6 +284,10 @@ const federation = createFederation<void>({ 


*This API is available since Fedify 1.6.0.*



> [!WARNING]

> The `@fedify/fedify/x/cfworkers` module is deprecated and will be removed in

> Fedify 2.0.0.  Please use the `@fedify/cfworkers` package instead.



`WorkersKvStore` is a key–value store implementation for [Cloudflare Workers]

that uses Cloudflare's built-in [Cloudflare Workers KV] API.  It provides

persistent storage and good performance for Cloudflare Workers environments.