diff --git a/readme.md b/readme.md index 82b88cb..9ec82f2 100644 --- a/readme.md +++ b/readme.md @@ -1,5 +1,57 @@ -> ## ChatBot +## ChatBot 🤖 -**Preview:** https://devnamdev2003.github.io/chatBot/ +An chatBot made with basic **HTML, CSS and Javascript.** -**About:** The goal of this project is to develop a simple chatbot that can provide answers to user queries related to a web application. The chatbot will be designed to assist users in navigating and using the web application, providing helpful responses and tips to improve user experience. \ No newline at end of file +--- + +Quick Preview ⚡
+https://devnamdev2003.github.io/chatBot/ + +Viewing Locally 📂 + +``` cmd +cd src/ +start index.html +``` + +--- + +## Contributing 🤝 + +1. Fork the repository if you haven't already + +2. Clone your fork locally 🙋‍♂ + +```sh +git clone https://github.com/YOUR_USERNAME/chatBot.git +``` +Replace "YOUR_USERNAME" with your GitHub username + +3. Create & Configure local branch 💁‍♂️ +```sh +git branch local +``` +Now switch to that branch via: +```sh +git checkout local +``` +4. Make changes and than run following command: +```sh +git add . +git commit -m "COMMIT_MESSAGE" +``` + +5. Finally, push your changes to your fork 📫 +```sh +git push origin local +``` + +6. To submit your changes to the main project, you'll need to create a pull request. I will merge it accordingly 🙌 + +--- + +## About 💁‍♂️ + +The goal of this project is to develop a simple chatbot that can provide answers to user queries related to a web application. The chatbot will be designed to assist users in navigating and using the web application, providing helpful responses and tips to improve user experience. + +Thank you ❤ diff --git a/index.html b/src/index.html similarity index 100% rename from index.html rename to src/index.html diff --git a/script.js b/src/script.js similarity index 100% rename from script.js rename to src/script.js diff --git a/style.css b/src/style.css similarity index 100% rename from style.css rename to src/style.css