From 98b672d51261152bd30c4acc9dc1c57d8fe81a43 Mon Sep 17 00:00:00 2001
From: Shreyas Shirish Agrawal <48771895+splendidbug@users.noreply.github.com>
Date: Sat, 24 Aug 2024 05:58:46 -0700
Subject: [PATCH] Update docs (#13)

* Update README.md

* Update index.md
---
 README.md         | 3 ++-
 docs/src/index.md | 3 ++-
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 4458440..371d974 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,7 @@ Pkg.add(url="https://github.com/JuliaGenAI/DocsScraper.jl")
 
 ## Building the Index
 ```julia
+using DocsScraper
 crawlable_urls = ["https://juliagenai.github.io/DocsScraper.jl/dev"]
 
 index_path = make_knowledge_packs(crawlable_urls;
@@ -120,4 +121,4 @@ index_name\
 ```
 - Index\: contains the .hdf5 and .tar.gz files along with the artifact__info.txt. Artifact info contains sha256 and git-tree-sha1 hashes. 
 - Scraped_files\: contains the scraped chunks and sources. These are separated by the hostnames of the URLs.
-- URL_mapping.csv contains the scraped URLs mapping them with the estimated package name.
\ No newline at end of file
+- URL_mapping.csv contains the scraped URLs mapping them with the estimated package name.
diff --git a/docs/src/index.md b/docs/src/index.md
index 6e9daba..5d3342d 100644
--- a/docs/src/index.md
+++ b/docs/src/index.md
@@ -30,6 +30,7 @@ Pkg.add(url="https://github.com/JuliaGenAI/DocsScraper.jl")
 
 ## Building the Index
 ```julia
+using DocsScraper
 crawlable_urls = ["https://juliagenai.github.io/DocsScraper.jl/dev"]
 
 index_path = make_knowledge_packs(crawlable_urls;
@@ -117,4 +118,4 @@ index_name\
 ```
 - Index\: contains the .hdf5 and .tar.gz files along with the artifact__info.txt. Artifact info contains sha256 and git-tree-sha1 hashes. 
 - Scraped_files\: contains the scraped chunks and sources. These are separated by the hostnames of the URLs.
-- URL_mapping.csv contains the scraped URLs mapping them with the estimated package name.
\ No newline at end of file
+- URL_mapping.csv contains the scraped URLs mapping them with the estimated package name.