Skip to content

Commit

Permalink
fix: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
junjie-w committed Dec 1, 2024
1 parent 49f5255 commit 5617793
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
4 changes: 1 addition & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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 :<port_number>
Expand All @@ -78,7 +77,6 @@ kill -9 <PID>

### 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
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 5617793

Please sign in to comment.