chore: bump version in package, update readme

Updated the new version in package.json . Fixed option type i.e. -p to -P . Added contribution and community note along with npm stats to readme.md.

Also updated the ci workflow to sync the version bump with repo code

Author: pradeept

.github/workflows/ci.yaml

@@ -1,3 +1,6 @@
+# How version bumping and publishing works?
+# Developer creates a tag with correct version number, 
+# attaches to the latest commit & pushes to the main branch
 name: CI
 
 on:
@@ -20,6 +23,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          token: ${{secrets.PAT_TOKEN}}
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
@@ -39,10 +44,14 @@ jobs:
       # commit message should include a valid tag
       # for pushing with tags use --follow-tags
       - name: Bump app version as per the tag
-        run: bun pm version from-git
+        run: |
+          bun pm version from-git -m "chore: update version"
 
       - name: Publish to npm using OIDC
         run: npm publish --provenance --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      
+      - name: Sync with repo 
+        run: git push origin main 
 

README.md

@@ -1,10 +1,19 @@
-# caching-proxy
+<div align='center'>
+
+# caching-proxy-cli
 
 A text based forward-proxy server with caching capability.
 
+[![npm version](https://img.shields.io/npm/v/caching-proxy-cli.svg)](https://www.npmjs.com/package/caching-proxy-cli)
+[![npm downloads](https://img.shields.io/npm/dm/caching-proxy-cli.svg)](https://www.npmjs.com/package/caching-proxy-cli)
+[![license](https://img.shields.io/npm/l/caching-proxy-cli.svg)](./LICENSE)
+
+</div>
+
 ## Pre-requisites
 - Bun - [installation guide](https://bun.com/docs/installation)
 - Node.js >=20.0
+- Redis [run in docker](https://redis.io/docs/latest/operate/oss_and_stack/install/install-stack/docker/)
 
 ## Installation
 
@@ -26,7 +35,7 @@ _Now, you can use the app from anywhere in your computer by typing
 
 ## Options
 -  __-V, --version__ : Output the version number
-- __-p, --port <number>__ : Port for proxy server
+- __-P, --port <number>__ : Port for proxy server
 - __-U, --url <URL>__ : URL of the server to which requests are forwarded
 - __-R, --redis <hostname:port>__ : Provide the redis <hostname:port>
 - __-C, --clear__: Clear cached responses
@@ -41,4 +50,13 @@ _Now, you can use the app from anywhere in your computer by typing
 - Clear the cache store.
 
 ## Credits
-[Backend Projects - Roadmap.sh](https://roadmap.sh/projects/caching-server)
+[Backend Projects - Roadmap.sh](https://roadmap.sh/projects/caching-server)
+
+## Contributing
+This project is open for contributions!
+
+If you’d like to help improve it, feel free to open an issue or submit a pull request - I’ll review it as soon as possible :)
+
+## Note
+This is a personal project intended for learning and experimentation.
+Contributions and testing are welcome — but it’s not ready (or meant) for production use.

package.json

@@ -2,9 +2,9 @@
   "name": "caching-proxy-cli",
   "module": "index.ts",
   "type": "module",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "repository": {
-    "url": "https://github.com/pradeept/caching-proxy-cli"
+    "url": "git+https://github.com/pradeept/caching-proxy-cli.git"
   },
   "bin": {
     "caching-proxy-cli": "index.ts"