improve readme

mahendraHegde · Apr 2, 2024 · 0d69ba9 · 0d69ba9
1 parent bf04255
commit 0d69ba9
Show file tree

Hide file tree

Showing 16 changed files with 134 additions and 30 deletions.
diff --git a/Readme.md b/Readme.md
@@ -1,13 +1,19 @@
 <h3> Node-Idempotency </h3>
-<i>makes any request idepotent.</i>
+<i>makes any request idempotent.</i>
 
 <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>
+#### Why?
+
+---
+
+Internet requests are unpredictable; clients/proxies may send duplicate or concurrent requests due to retries or network issues. To ensure smooth operation, servers must process each request only once. <i>**This package detects and handles duplicates, preventing issues like double charging the customer**</i>. It's:
+
+- <i>Race Condition free: </i> Ensures consistent behavior even during concurrent requests.
+- <i>Modular:</i> Easily integrates with your storage or existing implementation.
+- <i>Customizable:</i> options to tweak the library as per your need.
+- <i>[RFC](https://datatracker.ietf.org/doc/draft-ietf-httpapi-idempotency-key-header/) compliant: </i> Adheres to standards for compatibility with other systems/clients.
 
 and powers,
 
@@ -17,8 +23,12 @@ and powers,
 
 - [`@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

diff --git a/packages/core/CHANGELOG.md b/packages/core/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @node-idempotency/core
 
+## 1.0.6
+
+### Patch Changes
+
+- improve readme
+
 ## 1.0.5
 
 ### Patch Changes

diff --git a/packages/core/Readme.md b/packages/core/Readme.md
@@ -1,10 +1,16 @@
 #### @node-idempotency/core
+<i>makes any request idempotent.</i>
 
-Core package that is
+#### Why?
 
-- <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>
+---
+
+Internet requests are unpredictable; clients/proxies may send duplicate or concurrent requests due to retries or network issues. To ensure smooth operation, servers must process each request only once. <i>**This package detects and handles duplicates, preventing issues like double charging the customer**</i>. It's:
+
+- <i>Race Condition free: </i> Ensures consistent behavior even during concurrent requests.
+- <i>Modular:</i> Easily integrates with your storage or existing implementation.
+- <i>Customizable:</i> options to tweak the library as per your need.
+- <i>[RFC](https://datatracker.ietf.org/doc/draft-ietf-httpapi-idempotency-key-header/) compliant: </i> Adheres to standards for compatibility with other systems/clients.
 
 and powers
 
@@ -16,6 +22,8 @@ and powers
 
 if above packages dont meet your needs, you can utilise the core package directly to tweek it as per your needs.
 
+---
+
 ##### install
 
 ```bash

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@node-idempotency/core",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "A Race-Condition free Node.js library that ensures idempotency for requests, preventing unintended duplicate operations.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

diff --git a/packages/plugin-express/CHANGELOG.md b/packages/plugin-express/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @node-idempotency/express
 
+## 1.0.2
+
+### Patch Changes
+
+- improve readme
+- Updated dependencies
+  - @node-idempotency/core@1.0.6
+  - @node-idempotency/shared@1.0.2
+
 ## 1.0.1
 
 ### Patch Changes

diff --git a/packages/plugin-express/Readme.md b/packages/plugin-express/Readme.md
@@ -1,7 +1,22 @@
 #### @node-idempotency/express
 
-A Fastify plugin that makes requests idempotent
-Implements `@node-idempotency/core` as fastify plugin.
+An Express middleware that makes requests idempotent
+Implements `@node-idempotency/core` as express middleware.
+
+---
+
+#### Why?
+
+---
+
+Internet requests are unpredictable; clients/proxies may send duplicate or concurrent requests due to retries or network issues. To ensure smooth operation, servers must process each request only once. <i>**This package detects and handles duplicates, preventing issues like double charging the customer**</i>. It's:
+
+- <i>Race Condition free: </i> Ensures consistent behavior even during concurrent requests.
+- <i>Modular:</i> Easily integrates with your storage or existing implementation.(as simple as registering a middleware)
+- <i>Customizable:</i> options to tweak the library as per your need.
+- <i>[RFC](https://datatracker.ietf.org/doc/draft-ietf-httpapi-idempotency-key-header/) compliant: </i> Adheres to standards for compatibility with other systems/clients.
+
+---
 
 ##### instal
 

diff --git a/packages/plugin-express/package.json b/packages/plugin-express/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@node-idempotency/express",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Express middleware to provide Race-Condition free idempotency for HTTP requests, preventing unintended duplicate operations.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -46,8 +46,8 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@node-idempotency/core": "1.0.5",
-    "@node-idempotency/shared": "1.0.1",
+    "@node-idempotency/core": "1.0.6",
+    "@node-idempotency/shared": "1.0.2",
     "@node-idempotency/storage": "1.0.2",
     "@node-idempotency/storage-adapter-memory": "1.0.1",
     "express": "^4.19.2"

diff --git a/packages/plugin-fastify/CHANGELOG.md b/packages/plugin-fastify/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @node-idempotency/fastify
 
+## 1.0.2
+
+### Patch Changes
+
+- improve readme
+- Updated dependencies
+  - @node-idempotency/core@1.0.6
+  - @node-idempotency/shared@1.0.2
+
 ## 1.0.1
 
 ### Patch Changes

diff --git a/packages/plugin-fastify/Readme.md b/packages/plugin-fastify/Readme.md
@@ -3,6 +3,21 @@
 A Fastify plugin that makes requests idempotent
 Implements `@node-idempotency/core` as fastify plugin.
 
+---
+
+#### Why?
+
+---
+
+Internet requests are unpredictable; clients/proxies may send duplicate or concurrent requests due to retries or network issues. To ensure smooth operation, servers must process each request only once. <i>**This package detects and handles duplicates, preventing issues like double charging the customer**</i>. It's:
+
+- <i>Race Condition free: </i> Ensures consistent behavior even during concurrent requests.
+- <i>Modular:</i> Easily integrates with your storage or existing implementation.(as simple as registering a plugin to fastify)
+- <i>Customizable:</i> options to tweak the library as per your need.
+- <i>[RFC](https://datatracker.ietf.org/doc/draft-ietf-httpapi-idempotency-key-header/) compliant: </i> Adheres to standards for compatibility with other systems/clients.
+
+---
+
 ##### instal
 
 ```bash

diff --git a/packages/plugin-fastify/package.json b/packages/plugin-fastify/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@node-idempotency/fastify",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "fastify plugin that provides Race-Condition free idempotency for HTTP requests, preventing unintended duplicate operations.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -44,8 +44,8 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@node-idempotency/core": "1.0.5",
-    "@node-idempotency/shared": "1.0.1",
+    "@node-idempotency/core": "1.0.6",
+    "@node-idempotency/shared": "1.0.2",
     "@node-idempotency/storage": "1.0.2",
     "@node-idempotency/storage-adapter-memory": "1.0.1",
     "fastify": "^4.26.2",

diff --git a/packages/plugin-nestjs/CHANGELOG.md b/packages/plugin-nestjs/CHANGELOG.md
@@ -1,5 +1,14 @@
 # @node-idempotency/nestjs
 
+## 1.0.3
+
+### Patch Changes
+
+- improve readme
+- Updated dependencies
+  - @node-idempotency/core@1.0.6
+  - @node-idempotency/shared@1.0.2
+
 ## 1.0.2
 
 ### Patch Changes

diff --git a/packages/plugin-nestjs/Readme.md b/packages/plugin-nestjs/Readme.md
@@ -3,6 +3,21 @@
 Nestjs wrapper for Node-Idempotency.
 Implements `@node-idempotency/core` as a nestjs interceptor.
 
+---
+
+#### Why?
+
+---
+
+Internet requests are unpredictable; clients/proxies may send duplicate or concurrent requests due to retries or network issues. To ensure smooth operation, servers must process each request only once. <i>**This package detects and handles duplicates, preventing issues like double charging the customer**</i>. It's:
+
+- <i>Race Condition free: </i> Ensures consistent behavior even during concurrent requests.
+- <i>Modular:</i> Easily integrates with your storage or existing implementation, adding a decorator makes the endpoint idempotent.
+- <i>Customizable:</i> options to tweak the library as per your need.
+- <i>[RFC](https://datatracker.ietf.org/doc/draft-ietf-httpapi-idempotency-key-header/) compliant: </i> Adheres to standards for compatibility with other systems/clients.
+
+---
+
 ##### instal
 
 ```bash

diff --git a/packages/plugin-nestjs/package.json b/packages/plugin-nestjs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@node-idempotency/nestjs",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Nestjs Plugin that provides Race-Condition free idempotency for HTTP requests, preventing unintended duplicate operations.",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -44,8 +44,8 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@node-idempotency/core": "1.0.5",
-    "@node-idempotency/shared": "1.0.1",
+    "@node-idempotency/core": "1.0.6",
+    "@node-idempotency/shared": "1.0.2",
     "@node-idempotency/storage": "1.0.2"
   },
   "peerDependencies": {

diff --git a/packages/shared/CHANGELOG.md b/packages/shared/CHANGELOG.md
@@ -1,5 +1,12 @@
 # @node-idempotency/shared
 
+## 1.0.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @node-idempotency/core@1.0.6
+
 ## 1.0.1
 
 ### Patch Changes

diff --git a/packages/shared/package.json b/packages/shared/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@node-idempotency/shared",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -15,7 +15,7 @@
   "keywords": [],
   "author": "Mahendra Hegde",
   "dependencies": {
-    "@node-idempotency/core": "1.0.5",
+    "@node-idempotency/core": "1.0.6",
     "@node-idempotency/storage": "1.0.2",
     "@node-idempotency/storage-adapter-memory": "1.0.1",
     "@node-idempotency/storage-adapter-redis": "1.0.1"

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml