Update README.md

README.md

@@ -9,4 +9,29 @@ app_file: app.py
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+
+# *CLAS Basic Interaction Exercise*
+
+The Basic Interaction Exercise is web-based Chat interface where students interact with the chatbot that has had the instructor-designed prompt given to it but they cannot see the prompt. At the end of the conversation, entire convo is made available as downloadable JSON such that students can download it and turn it in to Brightspace. Ideated by Jesse Blocher (Ph.D.).
+
+# How to Run the App
+
+1. To clone the space, toggle on the three dots at the top right of the interface and click "Duplicate this space."
+2. In the pop-up, input secret values for OPEN_AI_KEY and SECRET_PROMPT. These values will not be visible after this step.
+
+# How to Use the App
+
+### Students
+
+1. Type something into the user input box, and click the "Send" button. The chatbot will respond to your message.
+2. Repeat step 1 to continue interaction with the chatbot instructor.
+3. Under "Generate the JSON file for your chat history!", click the "Generate" button to export your chat history as a JSON file.
+
+# How to Modify the App
+
+1. To modify the app, navigate to the "Files" page.
+2. Open the file named "app.py," and click the green "contribute" button above the code.
+3. Make desired modifications.
+4. Under "Propose changes", type a message to submit with your pull request.
+5. Add extended description, if desired.
+6. Click the "Open a Pull Request" button.