Update README.md

README.md

@@ -8,4 +8,28 @@ pinned: false
 license: lgpl-3.0
 ---
 
-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 that allows students to interact with a chatbot tutor. The tutor acts based on an instructor-designed prompt, not visible to students. At the end of the conversation, the entire conversation is made available as downloadable JSON, CSV, or TXT file such that students can download it and turn it in to Brightspace. Ideated by Jesse Blocher (Ph.D.).
+
+# How to Run the App - Instructors
+
+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 PIPLOC, OPEN_AI_KEY, SECRET_PROMPT. These values will not be visible after this step.
+
+# How to Use the App - Students
+
+1. Click the "Initialize Tutor" button at the top of the screen.
+2. Type something into the User Input box, and click the "Ask/answer model" button. The chatbot will respond to your message.
+3. Repeat step 2 to continue the back-and-forth interaction with the chatbot tutor.
+4. To view the conversation history, you may click the "View your chat history" button.
+5. When you have completed your interaction, export your chat history in the form of a .json, .txt, or .csv file by clicking the "JSON", "TXT", or "CSV" button at the bottom of the screen.
+
+# 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.