Skip to content

Commit

Permalink
update core readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mahendraHegde committed Mar 26, 2024
1 parent 4a651d1 commit 21d260a
Show file tree
Hide file tree
Showing 3 changed files with 4,428 additions and 1,910 deletions.
15 changes: 12 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,25 @@
<h3> Node-Idempotency </h3>
<i>Race-condition free library to make requests idempotenct.</i>
<i>makes any request idepotent.</i>

#### @node-idempotency/core
<br/>
<br/>
package that is

- <i>Race Condition free.</i>
- <i>Modular, you can attach your storage or plug in core implementation into your implemtation.</i>
- <i>[RFC](https://datatracker.ietf.org/doc/draft-ietf-httpapi-idempotency-key-header/) compliant. </i>

Core package that, makes requests idempotent and powers
and powers,

- [`@node-idempotency/nestjs`](https://www.npmjs.com/package/@node-idempotency/nestjs) - Plug and Play `nestjs` wrapper for `@node-idempotency/core`

- [`@node-idempotency/express`](https://www.npmjs.com/package/@node-idempotency/express) - Plug and Play `express` middleware for `@node-idempotency/core`

- [`@node-idempotency/fastify`](https://www.npmjs.com/package/@node-idempotency/fastify) - Plug and Play `fastify` plugin for `@node-idempotency/core`


#### @node-idempotency/core

if above packages dont meet your needs, you can utilise the core package directly to tweek it as per your needs.

##### install
Expand Down
8 changes: 7 additions & 1 deletion packages/core/Readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
#### @node-idempotency/core

Core package that, makes requests idempotent and powers
Core package that is

- <i>Race Condition free.</i>
- <i>Modular, you can attach your storage or plug in core implementation into your implemtation.</i>
- <i>[RFC](https://datatracker.ietf.org/doc/draft-ietf-httpapi-idempotency-key-header/) compliant. </i>

and powers

- [`@node-idempotency/nestjs`](https://www.npmjs.com/package/@node-idempotency/nestjs) - Plug and Play `nestjs` wrapper for `@node-idempotency/core`

Expand Down
Loading

0 comments on commit 21d260a

Please sign in to comment.