From be63189df5d49a06cbbbf335b6bc6b0cc773df15 Mon Sep 17 00:00:00 2001
From: Jeremiah Petersen <118206017+JeremiahPetersen@users.noreply.github.com>
Date: Sat, 9 Mar 2024 16:17:32 -0800
Subject: [PATCH] Update README.md re order running app

---
 README.md | 25 +++++++++++++------------
 1 file changed, 13 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index a50702a4..894abd64 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,19 @@
 
 RepoToText is a web app that scrapes a GitHub repository and converts its files into a single organized .txt. It allows you to enter the URL of a GitHub repository and an optional documentation URL (the doc info will append to the top of the .txt). The app retrieves the contents of the repository, including all files and directories, and also fetches the documentation from the provided URL and includes it in a single organized text file. The .txt file will be saved in the /data folder with user + repo + timestamp info. This file can then be uploaded to (GPT-4, Claude Opus, etc) and you can use the chatbot to interact with the entire GitHub repo. 
 
+## Running the Application with Docker
+
+To run the application using Docker, follow these steps:
+
+1. Clone the repository.
+2. Set up the environment variable `GITHUB_API_KEY` in the `.env` file.
+3. Build the Docker images with `docker compose build`.
+4. Start the containers with `docker compose up`.
+5. Access the application (http://localhost:3000) in a web browser and enter the GitHub repository URL and documentation URL (if available).
+6. Choose All files or choose specific file types.
+7. Click the "Submit" button to initiate the scraping process. The converted text will be displayed in the output area, and it will also be saved in the /data folder. 
+8. You can also click the "Copy Text" button to copy the generated text to the clipboard.
+
 ### Environment Configuration
 Add your GitHub API Key in the .env file 
 
@@ -40,18 +53,6 @@ FolderToText.py is a script that allows you to turn a local folder, or local fil
 - GitHub API: PyGithub library
 - Additional Python libraries: beautifulsoup4, requests, flask_cors, retry
 
-## Running the Application with Docker
-
-To run the application using Docker, follow these steps:
-
-1. Clone the repository.
-2. Set up the environment variable `GITHUB_API_KEY` in the `.env` file.
-3. Build the Docker images with `docker compose build`.
-4. Start the containers with `docker compose up`.
-5. Access the application (http://localhost:3000) in a web browser and enter the GitHub repository URL and documentation URL (if available).
-6. Choose All files or choose specific file types.
-7. Click the "Submit" button to initiate the scraping process. The converted text will be displayed in the output area, and it will also be saved in the /data folder. 
-8. You can also click the "Copy Text" button to copy the generated text to the clipboard.
 
 ## TODO