diff --git a/README.md b/README.md index 176091b..0d56695 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ import { createServer } from '@junjie-wu/echo-service'; const server = createServer(3000); ``` -### ๐Ÿงช Try it out +### ๐Ÿงช Try It Out ```bash # Check service health @@ -79,7 +79,7 @@ curl -X POST -H "Content-Type: application/json" \ ``` ### ๐Ÿ“‹ Examples -For complete working examples of all usage methods, check out the [examples](./examples) directory: +For complete working examples of all usage methods, check out the [examples](https://github.com/junjie-w/echo-service/tree/main/examples) directory: ```bash git clone https://github.com/junjie-w/echo-service.git cd echo-service/examples diff --git a/examples/README.md b/examples/README.md index 9cd49a6..39feb0e 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,6 +1,6 @@ # Echo Service Examples -Examples of using the [Echo Service](https://github.com/junjie-w/echo-service) via [Docker image](https://hub.docker.com/r/junjiewu0/echo-service) and [NPM package](https://www.npmjs.com/package/@junjie-wu/echo-service). +Examples of using [Echo Service](https://github.com/junjie-w/echo-service) via [Docker image](https://hub.docker.com/r/junjiewu0/echo-service) and [NPM package](https://www.npmjs.com/package/@junjie-wu/echo-service). ## ๐Ÿณ Docker Usage @@ -67,7 +67,6 @@ curl http://localhost:3001/echo ### Port Already in Use -If you see "Port in use" error: ```bash # Check what's using the port lsof -i : @@ -78,7 +77,6 @@ kill -9 ### Docker on ARM-based machines (Apple Silicon, etc.) -The example automatically handles platform differences, but you can manually run: ```bash docker pull --platform linux/amd64 junjiewu0/echo-service docker run --platform linux/amd64 -p 3003:3000 junjiewu0/echo-service diff --git a/package.json b/package.json index e90c0ac..6f68fff 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@junjie-wu/echo-service", "version": "1.1.1", - "description": "HTTP echo service for request inspection and testing - available as library, CLI tool, and Docker container", + "description": "HTTP echo service mirroring back request details. Available as Docker image and NPM package.", "author": "Junjie Wu", "license": "MIT", "type": "module",