Add README.md

README.md

@@ -1,8 +1,8 @@
 ---
 title: Data Science Tutor
-emoji: 🏢
-colorFrom: indigo
-colorTo: pink
+emoji: 📊
+colorFrom: gray
+colorTo: yellow
 sdk: streamlit
 sdk_version: 1.30.0
 app_file: app.py
@@ -10,4 +10,25 @@ pinned: false
 license: apache-2.0
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Data Science Tutor
+<p>
+This AI-powered chatbot was created by the Chat Completions and Moderations endpoints of OpenAI API. It acts like a data science tutor who provides accurate, clear answers to user's questions and It's sensitive to the contents that violate OpenAI's usage policies, including inciting violence, hate speech, and so forth.<br/>
+
+Its purpose is to assist users by providing concise and accurate answers in topics related to data such as data science, programming, mathematics, Artificial Intelligence, Machine Learning, Deep Learning, Databases, Data Engineering, and more. So, It may not be able to provide information on a wide range of topics beyond data science and programming.
+
+</p>
+
+# Usage
+<img src="https://i.postimg.cc/y6RxH9y1/combined-openai-api-drawio.png">
+1. To use <a href="https://huggingface.co/spaces/amirhoseinsedaghati/data_science_tutor">the online version</a>, just pass your question into the text area and click on <b>Generate Answer</b>.
+<br></br>
+2. To use it on your local machine, clone the project from <a href="https://github.com/amirho3einsedaghati/data_science_tutor">this URL GitHub</a> using <pre>git clone [email protected]:amirho3einsedaghati/data_science_tutor.git</pre> then navigate to the data_science_tutor directory containing the main.py file and run the Streamlit application using the command <pre>streamlit run main.py</pre>
+
+# License
+<a href="https://huggingface.co/spaces/amirhoseinsedaghati/data_science_tutor/blob/main/LICENSE">Apache-2.0</a>
+
+# Appendix:
+<a href="https://github.com/amirho3einsedaghati/data_science_tutor">https://github.com/amirho3einsedaghati/data_science_tutor</a>
+
+# Maintainer Contact:
+<a href="https://linktr.ee/amirhoseinsedaghati">https://linktr.ee/amirhoseinsedaghati</a>