From ffd6bf2fa9fc23257a396d4c929477ffe887b6a7 Mon Sep 17 00:00:00 2001
From: Alexander_Kabui
Date: Mon, 5 Aug 2024 12:05:08 +0300
Subject: Update docs: include prev commit for sanity.

---
 README.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 71d1917..27b662b 100644
--- a/README.md
+++ b/README.md
@@ -53,12 +53,13 @@ Gn-Markdown is an API endpoint to edit, parse, and commit markdown files for gn-
 
 ## Edit (GET)
 
-This is a GET request to retrieve a file's details.
+This is a GET request to retrieve a file's details. Make sure you pass a valid file_path as search_query (the path should be relative to the repo)
 
 **Request Example:**
 
 ```
 localhost:8091/edit?file_path=test.md
+
 ```
 
 **Expected Success Response:**
@@ -95,10 +96,11 @@ localhost:8091/commit
 ```json
 {
     "content": "Test for new user\n test 2 for line\n test 3 for new line\n ## real markdown two test\n",
-    "filename": "test.md",
+    "prev_commit"  : "ecd96f27c45301279150fbda411544687db1aa45",
+    "filename": "./test.md",
     "username": "genetics",
     "email": "genetics@gmail.com",
-    "commit": "commit by genetics"
+    "commit_message": "commit by genetics"
 }
 ```
 
-- 
cgit v1.2.3