From 9ac63c8db027d3f4651d7a17725d63270f80d484 Mon Sep 17 00:00:00 2001
From: Kfir Dayan <kfda89@gmail.com>
Date: Wed, 31 May 2023 15:30:31 +0300
Subject: [PATCH] README

---
 README.md | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/README.md b/README.md
index 835f8bd..22919be 100644
--- a/README.md
+++ b/README.md
@@ -50,6 +50,10 @@ ## API Endpoints ##
 
   # GET /api/crawl: 
     Crawls a website and stores the crawled data in the database. Required query parameter: url. Optional query parameter: depth (default: 1).
+    Parameters:
+    - `url` (required): The URL of the website to crawl.
+    - `depth` (optional): The depth of the crawling process (default: 1).
+    - `refresh` (optional): If set to true, the crawler will refresh the results for an existing URL (default: false).
   # GET /api:
     Retrieves all crawled data from the database.
   # DELETE /api/crawl/{id}: