modified the readme file

Author: muthukumar89uk

README.md

@@ -1,3 +1,48 @@
-# **Gin GORM REST APIs**
+# Gin GORM REST APIs
 
-Clone the git repo - `git clone https://github.com/muthukumar89uk/gin-RESTAPI-postgres-gorm.git` - or [download it](https://github.com/muthukumar89uk/gin-RESTAPI-postgres-gorm/zipball/master).
+This repository contains a RESTful API built using the Gin framework and GORM for database operations.
+
+## Features
+
+- CRUD operations
+- Database interaction with GORM
+- RESTful API structure
+
+## Requirements
+
+- Go 1.15 or higher
+- A running PostgreSQL database
+
+## Getting Started
+
+## Installation
+
+1. Clone the repository:
+
+   ```sh
+   git clone https://github.com/yourusername/gin-gorm-rest-api.git
+   cd gin-gorm-rest-api
+Click here to directly [download it](https://github.com/muthukumar89uk/go-chatapp-websocket/zipball/master).
+
+## Install dependencies:
+
+          go mod tidy
+
+## Run the Application
+  1. Run the Server
+   
+       ```
+          go run .
+2. The server will start on `http://localhost:8080`.
+
+## API Endpoints
+ 
+- `POST /user`      - Create a new user
+- `GET /users`      - Retrieve all user
+- `GET /user/:id`   - Retrieve an user by ID
+- `PUT /user/:id`   - Update an existing user
+- `DELETE /user/:id`- Delete an user
+
+## Refer
+  - [Gin Web Framework](https://github.com/gin-gonic/gin) 
+  - [GORM](https://gorm.io/)

routes/route.go

@@ -12,7 +12,7 @@ func SetupRouter() *gin.Engine {
 
 	grp1 := r.Group("/user-api")
 	{
-		grp1.GET("user", controllers.GetUsers)
+		grp1.GET("users", controllers.GetUsers)
 		grp1.POST("user", controllers.CreateUser)
 		grp1.GET("user/:id", controllers.GetUserByID)
 		grp1.PUT("user/:id", controllers.UpdateUser)