Update readme information

README.md

@@ -1,6 +1,18 @@
+# AI Scout
+Scouting has been a part of my life since I was a young man, now as a dad I volunteer my time for my son's troop.  As scouting has remained relevant to me I wanted to create an AI that will help with questions around Scouting.
 
+## Required Keys
+Open AI API Key - The user must enter their Open AI API key in the Gradio user interface.  The application will display an error message if 
+no API Key is entered or if their is an invalid Open AI API Key.
 
+## Cost
+The application is using GPT-4o-mini and the expected costs are as follows:
 
+| Type   | Number | Cost     |
+| ------ | ------ | -------- |
+| Input  | 15,000 | $0.00225 |
+| Output |  5,000 | $0.003   |
+| Total  |        | $0.00525 |
 
 ## Data
 Data processing infomation can be found here [Data](./data/data.md).

data/data.md

@@ -22,6 +22,8 @@ Run the following command to execute the data scraper script:
 
 `python3 data_scraper.py`
 
+
+
 ## Post Processing - optional
 
 The data that is downloaded is approximately 200 mb, to review the data it needs to be formatted, otherwise it will all be on a single line.
@@ -31,3 +33,6 @@ Run the following command from your terminal:
 `cat scout_information.json | python -m json.tool > pretty_scout_information.json`
 
 After reviewing the data for completeness delete the pretty_scout_information.json file as it is not needed for processing.
+
+The second step in the data scraper is creating a vector store.  Prior to this repo being created this vector store was uploaded to
+Huggingface Datasets and can be found here: `marty331/scouts_dataset_vector_store`.