Unverified Commit 649de509 authored by Hong Minhee's avatar Hong Minhee
Browse files

Standardize README files for monorepo structure 

- Remove GitHub Actions badges from package READMEs
- Standardize installation instructions across all packages
- Add packages table to main README
- Remove individual package changelogs (moved to monorepo)

[ci skip]
parent d27d22f2

amqp/README.md

+5 −50
Original line number Diff line number Diff line
@@ -5,7 +5,6 @@ 


[![JSR][JSR badge]][JSR]

[![npm][npm badge]][npm]

[![GitHub Actions][GitHub Actions badge]][GitHub Actions]



> [!NOTE]

>
@@ -45,8 +44,6 @@ For more details, please refer to the docs of [`AmqpMessageQueueOptions`]. 
[JSR badge]: https://jsr.io/badges/@fedify/amqp

[npm]: https://www.npmjs.com/package/@fedify/amqp

[npm badge]: https://img.shields.io/npm/v/@fedify/amqp?logo=npm

[GitHub Actions]: https://github.com/fedify-dev/amqp/actions/workflows/main.yaml

[GitHub Actions badge]: https://github.com/fedify-dev/amqp/actions/workflows/main.yaml/badge.svg

[RabbitMQ]: https://www.rabbitmq.com/

[Fedify]: https://fedify.dev/

[`KvStore`]: https://jsr.io/@fedify/fedify/doc/federation/~/KvStore
@@ -58,52 +55,10 @@ For more details, please refer to the docs of [`AmqpMessageQueueOptions`]. 
Installation

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



### Deno



~~~~ sh

deno add @fedify/amqp

~~~~



### Node.js



~~~~ sh

npm install @fedify/amqp

~~~~



### Bun



~~~~ sh

bun add @fedify/amqp

deno add jsr:@fedify/amqp  # Deno

npm  add     @fedify/amqp  # npm

pnpm add     @fedify/amqp  # pnpm

yarn add     @fedify/amqp  # Yarn

bun  add     @fedify/amqp  # Bun

~~~~
 




Changelog

---------



### Version 0.4.0



To be released.



### Version 0.3.0



Released on June 25, 2025.



 -  Added `nativeRetrial` option to `AmqpMessageQueueOptions` to enable

    native retrial of messages.



 -  The type of the `AmqpMessageQueue()` constructor's first parameter has been

    changed from `Connection` to `ChannelModel`.



### Version 0.2.0



Released on March 28, 2025.



 -  Added `AmqpMessageQueue.enqueueMany()` method for efficiently enqueuing

    multiple messages at once.



 -  Updated *@js-temporal/polyfill* to 0.5.0 for Node.js and Bun. On Deno,

    there is no change because the polyfill is not used.



### Version 0.1.0



Initial release.  Released on October 14, 2024.

fedify/README.md

+24 −0
Original line number Diff line number Diff line
@@ -81,6 +81,30 @@ join our [Matrix chat space][Matrix] or [Discord server][Discord] or 
[PeerTube]: https://joinpeertube.org/





Packages

--------



Fedify is a monorepo that contains several packages, each of which provides

different features and functionalities.  The main package is *@fedify/fedify*,

which provides the core functionality of the framework.  Other packages provide

integrations with various web frameworks, database drivers, and other features.

Here is the list of packages:



| Package                        | JSR                         | npm                         | Description                             |

| ------------------------------ | --------------------------- | --------------------------- | --------------------------------------- |

| [@fedify/fedify](/fedify/)     | [JSR]                       | [npm]                       | The core framework of Fedify            |

| [@fedify/cli](/cli/)           | [JSR][jsr:@fedify/cli]      | [npm][npm:@fedify/cli]      | CLI toolchain for testing and debugging |

| [@fedify/amqp](/amqp/)         | [JSR][jsr:@fedify/amqp]     | [npm][npm:@fedify/amqp]     | AMQP/RabbitMQ driver                    |

| [@fedify/postgres](/postgres/) | [JSR][jsr:@fedify/postgres] | [npm][npm:@fedify/postgres] | PostgreSQL driver                       |



[jsr:@fedify/cli]: https://jsr.io/@fedify/cli

[npm:@fedify/cli]: https://www.npmjs.com/package/@fedify/cli

[jsr:@fedify/amqp]: https://jsr.io/@fedify/amqp

[npm:@fedify/amqp]: https://www.npmjs.com/package/@fedify/amqp

[jsr:@fedify/postgres]: https://jsr.io/@fedify/postgres

[npm:@fedify/postgres]: https://www.npmjs.com/package/@fedify/postgres





Sponsors

--------

postgres/README.md

+5 −74
Original line number Diff line number Diff line
@@ -5,7 +5,6 @@ 


[![JSR][JSR badge]][JSR]

[![npm][npm badge]][npm]

[![GitHub Actions][GitHub Actions badge]][GitHub Actions]



This package provides [Fedify]'s [`KvStore`] and [`MessageQueue`]

implementations for PostgreSQL:
@@ -30,8 +29,6 @@ const federation = createFederation({ 
[JSR badge]: https://jsr.io/badges/@fedify/postgres

[npm]: https://www.npmjs.com/package/@fedify/postgres

[npm badge]: https://img.shields.io/npm/v/@fedify/postgres?logo=npm

[GitHub Actions]: https://github.com/fedify-dev/postgres/actions/workflows/main.yaml

[GitHub Actions badge]: https://github.com/fedify-dev/postgres/actions/workflows/main.yaml/badge.svg

[Fedify]: https://fedify.dev/

[`KvStore`]: https://jsr.io/@fedify/fedify/doc/federation/~/KvStore

[`MessageQueue`]: https://jsr.io/@fedify/fedify/doc/federation/~/MessageQueue
@@ -42,76 +39,10 @@ const federation = createFederation({ 
Installation

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



### Deno



~~~~ sh

deno add @fedify/postgres

~~~~



### Node.js



~~~~ sh

npm install @fedify/postgres

~~~~



### Bun



~~~~ sh

bun add @fedify/postgres

deno add jsr:@fedify/postgres  # Deno

npm  add     @fedify/postgres  # npm

pnpm add     @fedify/postgres  # pnpm

yarn add     @fedify/postgres  # Yarn

bun  add     @fedify/postgres  # Bun

~~~~
 




Changelog

---------



### Version 0.4.0



To be released.



### Version 0.3.0



Released on March 28, 2025.



 -  Added `PostgresMessageQueue.enqueueMany()` method for efficiently enqueuing

    multiple messages at once.



 -  Updated *@js-temporal/polyfill* to 0.5.0 for Node.js and Bun. On Deno,

    there is no change because the polyfill is not used.



 -  Added some logging using [LogTape] for the sake of debugging.  The following

    categories are used:



     -  `["fedify", "postgres", "kv"]`

     -  `["fedify", "postgres", "mq"]`



[LogTape]: https://logtape.org/



### Version 0.2.2



Released on November 18, 2024.



 -  Fixed a bug where binding parameters have not been properly escaped with

    some settings of Postgres.js.



### Version 0.2.1



Released on November 3, 2024.



 -  Fixed a bug where some scalar values have failed to be stored in the

    database.



### Version 0.2.0



Released on November 3, 2024.



 -  Fixed a bug where JSON values are double-quoted in the database.  Since it's

    a breaking change data-wise, the default values of the following options

    are also changed:



     -  `PostgresKvStoreOptions.tableName` defaults to `"fedify_kv_v2"`.

     -  `PostgresMessageQueueOptions.tableName` defaults to

        `"fedify_message_v2"`.



### Version 0.1.0



Initial release.  Released on September 26, 2024.