Add README.md File

Author: Mohammad Hamdan

README.md

@@ -0,0 +1,87 @@
+# Real-Time Item Tracking Service
+
+A Go-based real-time tracking service using **WebSocket**, **gRPC**, and **Redis** for persistent geolocation data.
+
+## Features
+
+- **WebSocket API** to receive live position updates from clients.
+- **gRPC API** for backend services to retrieve current positions.
+- **Redis** storage for fast reads and writes.
+- Thread-safe client connection management.
+- Basic error handling and logging.
+
+## Requirements
+
+- Go 1.21+
+- Redis 7+
+- Protocol Buffers Compiler (`protoc`)
+
+## Installation
+
+```bash
+git clone https://github.com/<your-username>/<your-repo>.git
+cd <your-repo>
+go mod tidy
+```
+
+## Configuration
+
+Set the required environment variables:
+
+```bash
+export REDIS_ADDR="localhost:6379"
+export REDIS_PASSWORD="yourpassword"
+export GRPC_PORT="50051"
+export WS_PORT="8080"
+```
+
+## Running the Service
+
+```bash
+go run cmd/server/main.go
+```
+
+## WebSocket Usage
+
+1. Connect to: `ws://localhost:8080/ws`
+2. Send handshake JSON:
+
+```json
+{
+    "item_id": "your-item-id"
+}
+```
+
+3. Send position updates:
+
+```json
+{
+    "latitude": 35.6895,
+    "longitude": 139.6917
+}
+```
+
+## gRPC Usage
+
+The gRPC service exposes:
+
+- **GetCurrentPosition** — Retrieve the latest position for an item.
+
+Example gRPC call in Go:
+
+```go
+resp, err := client.GetCurrentPosition(ctx, &pb.ItemRequest{ItemId: "your-item-id"})
+if err != nil {
+    log.Fatal(err)
+}
+fmt.Println(resp)
+```
+
+## Versioning
+
+Current release: **v0.1.0**  
+Following [Semantic Versioning](https://semver.org/).
+
+## License
+
+MIT License